From 31f9a34571b3b36ce9d9474ec1d2e9555060d4d8 Mon Sep 17 00:00:00 2001 From: Isaac Lewis Date: Tue, 20 Feb 2018 17:08:21 -0800 Subject: [PATCH] init; some tests --- .gitignore | 11 +++++++++++ .rspec | 3 +++ .travis.yml | 5 +++++ CODE_OF_CONDUCT.md | 74 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ Gemfile | 6 ++++++ LICENSE.txt | 21 +++++++++++++++++++++ README.md | 43 +++++++++++++++++++++++++++++++++++++++++++ Rakefile | 6 ++++++ bin/console | 14 ++++++++++++++ bin/setup | 8 ++++++++ lib/syspro.rb | 5 +++++ lib/syspro/version.rb | 3 +++ spec/spec_helper.rb | 14 ++++++++++++++ spec/syspro_spec.rb | 116 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ syspro.gemspec | 36 ++++++++++++++++++++++++++++++++++++ 15 files changed, 365 insertions(+), 0 deletions(-) create mode 100644 .gitignore create mode 100644 .rspec create mode 100644 .travis.yml create mode 100644 CODE_OF_CONDUCT.md create mode 100644 Gemfile create mode 100644 LICENSE.txt create mode 100644 README.md create mode 100644 Rakefile create mode 100755 bin/console create mode 100755 bin/setup create mode 100644 lib/syspro.rb create mode 100644 lib/syspro/version.rb create mode 100644 spec/spec_helper.rb create mode 100644 spec/syspro_spec.rb create mode 100644 syspro.gemspec diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..b04a8c8 --- /dev/null +++ b/.gitignore @@ -0,0 +1,11 @@ +/.bundle/ +/.yardoc +/_yardoc/ +/coverage/ +/doc/ +/pkg/ +/spec/reports/ +/tmp/ + +# rspec failure tracking +.rspec_status diff --git a/.rspec b/.rspec new file mode 100644 index 0000000..34c5164 --- /dev/null +++ b/.rspec @@ -0,0 +1,3 @@ +--format documentation +--color +--require spec_helper diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 0000000..431eb4d --- /dev/null +++ b/.travis.yml @@ -0,0 +1,5 @@ +sudo: false +language: ruby +rvm: + - 2.3.1 +before_install: gem install bundler -v 1.16.1 diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..620452b --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,74 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +In the interest of fostering an open and welcoming environment, we as +contributors and maintainers pledge to making participation in our project and +our community a harassment-free experience for everyone, regardless of age, body +size, disability, ethnicity, gender identity and expression, level of experience, +nationality, personal appearance, race, religion, or sexual identity and +orientation. + +## Our Standards + +Examples of behavior that contributes to creating a positive environment +include: + +* Using welcoming and inclusive language +* Being respectful of differing viewpoints and experiences +* Gracefully accepting constructive criticism +* Focusing on what is best for the community +* Showing empathy towards other community members + +Examples of unacceptable behavior by participants include: + +* The use of sexualized language or imagery and unwelcome sexual attention or +advances +* Trolling, insulting/derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or electronic + address, without explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Our Responsibilities + +Project maintainers are responsible for clarifying the standards of acceptable +behavior and are expected to take appropriate and fair corrective action in +response to any instances of unacceptable behavior. + +Project maintainers have the right and responsibility to remove, edit, or +reject comments, commits, code, wiki edits, issues, and other contributions +that are not aligned to this Code of Conduct, or to ban temporarily or +permanently any contributor for other behaviors that they deem inappropriate, +threatening, offensive, or harmful. + +## Scope + +This Code of Conduct applies both within project spaces and in public spaces +when an individual is representing the project or its community. Examples of +representing a project or community include using an official project e-mail +address, posting via an official social media account, or acting as an appointed +representative at an online or offline event. Representation of a project may be +further defined and clarified by project maintainers. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported by contacting the project team at isaac@ike.io. All +complaints will be reviewed and investigated and will result in a response that +is deemed necessary and appropriate to the circumstances. The project team is +obligated to maintain confidentiality with regard to the reporter of an incident. +Further details of specific enforcement policies may be posted separately. + +Project maintainers who do not follow or enforce the Code of Conduct in good +faith may face temporary or permanent repercussions as determined by other +members of the project's leadership. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, +available at [http://contributor-covenant.org/version/1/4][version] + +[homepage]: http://contributor-covenant.org +[version]: http://contributor-covenant.org/version/1/4/ diff --git a/Gemfile b/Gemfile new file mode 100644 index 0000000..2751b83 --- /dev/null +++ b/Gemfile @@ -0,0 +1,6 @@ +source "https://rubygems.org" + +git_source(:github) {|repo_name| "https://github.com/#{repo_name}" } + +# Specify your gem's dependencies in syspro.gemspec +gemspec diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 0000000..70f1bf9 --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,21 @@ +The MIT License (MIT) + +Copyright (c) 2018 Isaac Lewis + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. diff --git a/README.md b/README.md new file mode 100644 index 0000000..ce9def8 --- /dev/null +++ b/README.md @@ -0,0 +1,43 @@ +# Syspro + +Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/syspro`. To experiment with that code, run `bin/console` for an interactive prompt. + +TODO: Delete this and the text above, and describe your gem + +## Installation + +Add this line to your application's Gemfile: + +```ruby +gem 'syspro' +``` + +And then execute: + + $ bundle + +Or install it yourself as: + + $ gem install syspro + +## Usage + +TODO: Write usage instructions here + +## Development + +After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment. + +To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org). + +## Contributing + +Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/syspro. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct. + +## License + +The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT). + +## Code of Conduct + +Everyone interacting in the Syspro project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/syspro/blob/master/CODE_OF_CONDUCT.md). diff --git a/Rakefile b/Rakefile new file mode 100644 index 0000000..b7e9ed5 --- /dev/null +++ b/Rakefile @@ -0,0 +1,6 @@ +require "bundler/gem_tasks" +require "rspec/core/rake_task" + +RSpec::Core::RakeTask.new(:spec) + +task :default => :spec diff --git a/bin/console b/bin/console new file mode 100755 index 0000000..8cd9ffd --- /dev/null +++ b/bin/console @@ -0,0 +1,14 @@ +#!/usr/bin/env ruby + +require "bundler/setup" +require "syspro" + +# You can add fixtures and/or initialization code here to make experimenting +# with your gem easier. You can also use a different console, if you like. + +# (If you use this, don't forget to add pry to your Gemfile!) +# require "pry" +# Pry.start + +require "irb" +IRB.start(__FILE__) diff --git a/bin/setup b/bin/setup new file mode 100755 index 0000000..dce67d8 --- /dev/null +++ b/bin/setup @@ -0,0 +1,8 @@ +#!/usr/bin/env bash +set -euo pipefail +IFS=$'\n\t' +set -vx + +bundle install + +# Do any other automated setup that you need to do here diff --git a/lib/syspro.rb b/lib/syspro.rb new file mode 100644 index 0000000..5bad531 --- /dev/null +++ b/lib/syspro.rb @@ -0,0 +1,5 @@ +require "syspro/version" + +module Syspro + # Your code goes here... +end diff --git a/lib/syspro/version.rb b/lib/syspro/version.rb new file mode 100644 index 0000000..91cd027 --- /dev/null +++ b/lib/syspro/version.rb @@ -0,0 +1,3 @@ +module Syspro + VERSION = "0.1.0" +end diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb new file mode 100644 index 0000000..089555a --- /dev/null +++ b/spec/spec_helper.rb @@ -0,0 +1,14 @@ +require "bundler/setup" +require "syspro" + +RSpec.configure do |config| + # Enable flags like --only-failures and --next-failure + config.example_status_persistence_file_path = ".rspec_status" + + # Disable RSpec exposing methods globally on `Module` and `main` + config.disable_monkey_patching! + + config.expect_with :rspec do |c| + c.syntax = :expect + end +end diff --git a/spec/syspro_spec.rb b/spec/syspro_spec.rb new file mode 100644 index 0000000..1b186ed --- /dev/null +++ b/spec/syspro_spec.rb @@ -0,0 +1,116 @@ +RSpec.describe Syspro do + server_name = "dev3" + + Rspec.describe PrimitiveClient do + base_url = "http://#{server_name}/SYSPROWCFService" + binding = "RESTHttp" + + it "has a version number" do + expect(Syspro::VERSION).not_to be nil + end + + it "does something useful" do + expect(false).to eq(true) + end + + it "can be instantiated" do + expect { + sys = Syspro::PrimitiveClient.new(base_url, binding) + }.not_to raise_error + end + + it "can login to a syspro database" do + sys = Syspro::PrimitiveClient.new(base_url, binding) + login_reply = sys.login(operator_name, password, company_id, company_password) + + expect(login_reply).to eq(login_reply_example) + end + + it "can logoff from a syspro database" do + sys = Syspro::PrimitiveClient.new(base_url, binding) + logoff_reply = sys.logoff(user_id) + + expect(logoff_reply).to eq(logoff_reply_example) + end + + Rspec.describe Query do + sys = Syspro::PrimitiveClient.new(base_url, binding) + + it "can query browse" do + query_result = sys.query_browse(user_id, query_object) + + expect(query_result).to eq(query_result_example) + end + + it "can query fetch" do + query_result = sys.query_fetch(user_id, query_object) + + expect(query_result).to eq(query_result_example) + end + + it "can query query" do + query_result = sys.query_query(user_id, business_object, query_object) + + expect(query_result).to eq(query_result_example) + end + end + + Rspec.describe Setup do + sys = Syspro::PrimitiveClient.new(base_url, binding) + + it "can add" do + setup_result = sys.setup_add(user_id, business_object, params, query_object) + + expect(setup_result).to eq(setup_result_example) + end + + it "can delete" do + setup_result = sys.setup_delete(user_id, business_object, params, query_object) + + expect(setup_result).to eq(setup_result_example) + end + + it "can update" do + setup_result = sys.setup_update(user_id, business_object, params, query_object) + + expect(setup_result).to eq(setup_result_example) + end + end + + Rspec.describe Transaction do + sys = Syspro::PrimitiveClient.new(base_url, binding) + + it "can build" do + expect(sys.transaction_build(user_id, business_object, query_object)).to eq(transaction_result_example) + end + + it "can post" do + expect(sys.transaction_post(user_id, business_object, query_object)).to eq(transaction_result_example) + end + end + + Rspec.describe Asynchronous do + # TODO: Describe asynchronous versions of above methods + end + + end # Primitive + + Rpec.describe Client do + base_url = "http://#{server_name}/SYSPROWCFService" + binding = "RESTHttp" + + Rspec.describe Utilities do + + end + + Rspec.describe Query do + end + + Rspec.describe Setup do + end + + Rspec.describe Transaction do + end + end # Client +end + diff --git a/syspro.gemspec b/syspro.gemspec new file mode 100644 index 0000000..3024f07 --- /dev/null +++ b/syspro.gemspec @@ -0,0 +1,36 @@ + +lib = File.expand_path("../lib", __FILE__) +$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib) +require "syspro/version" + +Gem::Specification.new do |spec| + spec.name = "syspro" + spec.version = Syspro::VERSION + spec.authors = ["Isaac Lewis"] + spec.email = ["isaac@ike.io"] + + spec.summary = %q{TODO: Write a short summary, because RubyGems requires one.} + spec.description = %q{TODO: Write a longer description or delete this line.} + spec.homepage = "TODO: Put your gem's website or public repo URL here." + spec.license = "MIT" + + # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host' + # to allow pushing to a single host or delete this section to allow pushing to any host. + if spec.respond_to?(:metadata) + spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'" + else + raise "RubyGems 2.0 or newer is required to protect against " \ + "public gem pushes." + end + + spec.files = `git ls-files -z`.split("\x0").reject do |f| + f.match(%r{^(test|spec|features)/}) + end + spec.bindir = "exe" + spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) } + spec.require_paths = ["lib"] + + spec.add_development_dependency "bundler", "~> 1.16" + spec.add_development_dependency "rake", "~> 10.0" + spec.add_development_dependency "rspec", "~> 3.0" +end -- libgit2 0.21.4