pvdgm-svc-client 0.1.6

data/spec/base_resource_spec.rb

@@ -0,0 +1,208 @@
+require 'spec_helper'
+
+describe BaseResource do
+
+  context 'Private Methods' do
+
+    before(:each) do 
+      @cut = BaseResource.new({ use_ssl: false, server: 'localhost:3000', api_token: 'sltc_api_token'})
+    end
+
+    context '#invoke_rest' do
+
+      it "should return a raw string if a non-JSON response is made from the block" do
+        result = @cut.send(:invoke_rest, false) do 
+          "abc123"
+        end
+        expect(result).to eq("abc123")
+      end
+
+      it "should parse a response as JSON by default" do
+        result = @cut.send(:invoke_rest) do
+          '{ "message": "from the other side" }'
+        end
+        expect(result).to eq({ 'message' => 'from the other side' })
+      end
+
+      it "should output an error message and exit if the JSON payload is invalid" do
+        expect {
+          @cut.send(:invoke_rest) do
+            '{ message => 3'
+          end
+        }.to raise_error(SystemExit)
+      end
+
+      it "should output an error message and exit if there is a non-403,404 exception" do
+        mock_response = double("Response")
+        mock_response.should_receive(:code).any_number_of_times.and_return(500)
+        mock_response.should_receive(:description).and_return("System error")
+
+        expect {
+          @cut.send(:invoke_rest) do
+            raise RestClient::Exception.new(mock_response, 500)
+          end
+        }.to raise_error(SystemExit)
+      end
+
+      it "should output an error message and exit if there is a 403 exception with no json" do
+        mock_response = double("Response")
+        mock_response.should_receive(:code).any_number_of_times.and_return(403)
+        mock_response.should_receive(:description).and_return("Some other error")
+
+        expect {
+          @cut.send(:invoke_rest, false) do
+            raise RestClient::Exception.new(mock_response, 403)
+          end
+        }.to raise_error(SystemExit)
+      end
+
+      it "should output an error message and exit if there is a 404 exception with error json" do
+        mock_response = double("Response")
+        mock_response.stub(:code).and_return(404)
+        mock_response.should_receive(:description).and_return("Some other error")
+        mock_response.should_receive(:http_body).and_return('{ "error" : "Error message" }')
+
+        expect {
+          @cut.send(:invoke_rest) do
+            raise RestClient::Exception.new(mock_response, 404)
+          end
+        }.to raise_error(SystemExit)
+      end
+
+      it "should output an error message and exit if there is a 403 exception with validation error json" do
+        mock_response = double("Response")
+        mock_response.should_receive(:code).any_number_of_times.and_return(403)
+        mock_response.should_receive(:description).and_return("Some other error")
+        mock_response.should_receive(:http_body).and_return('{ "validation_error" : { "name" : [ "Error 1", "Error 2" ] } }')
+
+        expect {
+          @cut.send(:invoke_rest) do
+            raise RestClient::Exception.new(mock_response, 403)
+          end
+        }.to raise_error(SystemExit)
+      end
+
+      it "should output an error message and exit if there is a 403 exception with some other error json" do
+        mock_response = double("Response")
+        mock_response.should_receive(:code).any_number_of_times.and_return(403)
+        mock_response.should_receive(:description).and_return("Some other error")
+        mock_response.should_receive(:http_body).and_return('{ "other_error" : { "name" : [ "Error 1", "Error 2" ] } }')
+
+        expect {
+          @cut.send(:invoke_rest) do
+            raise RestClient::Exception.new(mock_response, 403)
+          end
+        }.to raise_error(SystemExit)
+      end
+
+      it "should output an error message and exit if there is a 403 exception with invalid validation error json" do
+        mock_response = double("Response")
+        mock_response.should_receive(:code).any_number_of_times.and_return(403)
+        mock_response.should_receive(:description).and_return("Some other error")
+        mock_response.should_receive(:http_body).any_number_of_times.and_return('{ "validation_error" : { "name" :  "Error 1", "Error 2" ] } }')
+
+        expect {
+          @cut.send(:invoke_rest) do
+            raise RestClient::Exception.new(mock_response, 403)
+          end
+        }.to raise_error(SystemExit)
+      end
+
+      it "should output an error message and exit if there is an unknown exception raised in the block" do
+        expect {
+          @cut.send(:invoke_rest) do
+            raise "Some unknown exception"
+          end
+        }.to raise_error(SystemExit)
+      end
+
+    end
+
+    context '#get' do
+
+      it "should return the response from the GET call" do
+        @cut.should_receive(:invoke_rest).with(true).and_yield
+        
+        RestClient.should_receive(:get).
+          with('http://localhost:3000/tubes', {"Authorization"=>"Token token=\"sltc_api_token\"" }).
+          and_return({ hey: 'guy' })
+
+        expect(@cut.send(:get, 'tubes')).to eq({ hey: 'guy' })
+      end
+
+    end
+
+    context '#delete' do
+
+      it "should return the response from the DELETE call" do
+        @cut.should_receive(:invoke_rest).with(true).and_yield
+        
+        RestClient.should_receive(:delete).
+          with('http://localhost:3000/tubes', {"Authorization"=>"Token token=\"sltc_api_token\"" }).
+          and_return({ hey: 'guy' })
+
+        expect(@cut.send(:delete, 'tubes')).to eq({ hey: 'guy' })
+      end
+
+    end
+
+    context '#post' do
+
+      it "should return the response from the POST call" do
+        @cut.should_receive(:invoke_rest).with(true).and_yield
+        
+        RestClient.should_receive(:post).
+          with('http://localhost:3000/tubes', 
+               {"param1"=>"pvalue"},
+               {"Authorization"=>"Token token=\"sltc_api_token\"" }).
+          and_return({ hey: 'guy' })
+
+        expect(@cut.send(:post, 'tubes', { 'param1' => 'pvalue' })).to eq({ hey: 'guy' })
+      end
+
+    end
+
+    context '#put' do
+
+      it "should return the response from the PUT call" do
+        @cut.should_receive(:invoke_rest).with(true).and_yield
+        
+        RestClient.should_receive(:put).
+          with('http://localhost:3000/tubes', 
+               {"param1"=>"pvalue"},
+               {"Authorization"=>"Token token=\"sltc_api_token\"" }).
+          and_return({ hey: 'guy' })
+
+        expect(@cut.send(:put, 'tubes', { 'param1' => 'pvalue' })).to eq({ hey: 'guy' })
+      end
+
+    end
+
+    context '#build_url' do
+
+      it "should return the properly formatted url" do
+        @cut.options[:use_ssl] = false
+        @cut.options[:server] = 'www.bob.com'
+
+        expect(@cut.send(:build_url, 'the_uri')).to eq('http://www.bob.com/the_uri')
+
+        @cut.options[:use_ssl] = true
+        
+        expect(@cut.send(:build_url, 'the_uri')).to eq('https://www.bob.com/the_uri')
+      end
+
+    end
+
+    context '#authentication_headers' do
+
+      it "should return a hash containing the authentication headers" do
+        @cut.options[:api_token] = 'this is the token string'
+        expect(@cut.send(:authentication_headers)).
+          to eq( { 'Authorization' => "Token token=\"this is the token string\"" } )
+      end
+
+    end
+
+  end
+
+end

data/spec/service_mgr_options_spec.rb

@@ -0,0 +1,266 @@
+require 'spec_helper'
+
+describe ServiceMgrOptions do
+
+  # The current set of all resources. This automatically updates if new
+  # resources are added to the application
+  RESOURCES = Resources.constants.map { | const | ActiveSupport::Inflector.underscore(const.to_s) }
+  COMMANDS = RESOURCES.inject(Hash.new { | h, k | h[k] = [] }) do | acc, resource |
+    acc.tap do | a |
+      a[resource] = eval("Resources::#{ActiveSupport::Inflector.camelize(resource)}").instance_methods(false)
+    end
+  end
+
+  before(:each) do
+    @cut = ServiceMgrOptions.new
+  end
+
+  context 'Public Methods' do
+
+    context '#parse_options!' do
+
+      context 'without an api token' do
+      
+        it "should raise an exception if no API token has been specified" do
+          argv = []
+          expect { @cut.parse_options!(argv) }.
+            to raise_error(SystemExit)
+        end
+
+      end
+
+      context 'with an api token' do
+
+        it "should provide a default resource and command if none is specified on the command line" do
+          argv = ['--token', 'the_token' ]
+          expect(@cut.parse_options!(argv)).
+            to eq([ { server: 'www.abaqis.com', use_ssl: true, api_token: 'the_token', trace: false }, # Default options
+                    'service', # Default resource
+                    'list' ]) # Default command
+        end
+
+        it "should use the specified resource and infer the command when the command is not specified" do
+          argv = ['--token', 'the_token', 'service' ]
+          expect(@cut.parse_options!(argv)).
+            to eq([ { server: 'www.abaqis.com', use_ssl: true, api_token: 'the_token', trace: false }, # Default options
+                    'service', # Specified resource
+                    'list' ]) # Default command
+        end
+
+        it "should use the specified resource and command when specified" do
+          argv = ['--token', 'the_token', 'service', 'show' ]
+          expect(@cut.parse_options!(argv)).
+            to eq([ { server: 'www.abaqis.com', use_ssl: true, api_token: 'the_token', trace: false }, # Default options
+                    'service', # Specified resource
+                    'show' ]) # Specified command
+        end
+
+        it "should render the help display and exit when the help option is specified" do
+          argv = [ '--help' ]
+          expect { @cut.parse_options!(argv) }.
+            to raise_error(SystemExit)
+        end
+
+        it "should set the server option" do
+          argv = ['--token', 'the_token', '--server', 'test.abaqis.int' ]
+          expect(@cut.parse_options!(argv)).
+            to eq([ { server: 'test.abaqis.int', 
+                      use_ssl: true, 
+                      api_token: 'the_token',
+                      trace: false }, # Default options
+                    'service', # Default resource
+                    'list' ]) # Default command
+        end
+
+        it "should set the server/ssl option for local testing" do
+          argv = ['--token', 'the_token', '--local']
+          expect(@cut.parse_options!(argv)).
+            to eq([ { server: 'localhost:3000', 
+                      use_ssl: false, 
+                      api_token: 'the_token',
+                      trace: false }, # Default options
+                    'service', # Default resource
+                    'list' ]) # Default command
+        end
+
+        it "should set the server/ssl option for uat testing" do
+          argv = ['--token', 'the_token', '--uat']
+          expect(@cut.parse_options!(argv)).
+            to eq([ { server: 'uat.abaqis.com', 
+                      use_ssl: true, 
+                      api_token: 'the_token',
+                      trace: false }, # Default options
+                    'service', # Default resource
+                    'list' ]) # Default command
+        end
+
+        it "should display the resources/commands and exit" do
+          argv = [ '--list' ]
+          expect { @cut.parse_options!(argv) }.
+            to raise_error(SystemExit)
+        end
+
+        it "should set the trace option" do
+          argv = ['--token', 'the_token', '--trace']
+          expect(@cut.parse_options!(argv)).
+            to eq([ { server: 'www.abaqis.com', 
+                      use_ssl: true, 
+                      api_token: 'the_token',
+                      trace: true }, # Default options
+                    'service', # Default resource
+                    'list' ]) # Default command
+        end
+
+        it "should the set the account mapping id" do
+          argv = ['--token', 'the_token', '--account-mapping-id', "234"]
+          expect(@cut.parse_options!(argv)).
+            to eq([ { server: 'www.abaqis.com', 
+                      use_ssl: true, 
+                      api_token: 'the_token',
+                      trace: false, 
+                      account_mapping_id: "234" }, # Default options
+                    'service', # Default resource
+                    'list' ]) # Default command
+        end
+
+        it "should the set the configured account id" do
+          argv = ['--token', 'the_token', '--configured-account-id', "234"]
+          expect(@cut.parse_options!(argv)).
+            to eq([ { server: 'www.abaqis.com', 
+                      use_ssl: true, 
+                      api_token: 'the_token',
+                      trace: false, 
+                      configured_account_id: "234" }, # Default options
+                    'service', # Default resource
+                    'list' ]) # Default command
+        end
+
+        it "should the set the facility mapping id" do
+          argv = ['--token', 'the_token', '--facility-mapping-id', "234"]
+          expect(@cut.parse_options!(argv)).
+            to eq([ { server: 'www.abaqis.com', 
+                      use_ssl: true, 
+                      api_token: 'the_token',
+                      trace: false, 
+                      facility_mapping_id: "234" }, # Default options
+                    'service', # Default resource
+                    'list' ]) # Default command
+        end
+
+        it "should the set the service definition id" do
+          argv = ['--token', 'the_token', '--service-definition-id', "234"]
+          expect(@cut.parse_options!(argv)).
+            to eq([ { server: 'www.abaqis.com', 
+                      use_ssl: true, 
+                      api_token: 'the_token',
+                      trace: false, 
+                      service_definition_id: "234" }, # Default options
+                    'service', # Default resource
+                    'list' ]) # Default command
+        end
+
+        it "should the set the service id" do
+          argv = ['--token', 'the_token', '--service-id', "234"]
+          expect(@cut.parse_options!(argv)).
+            to eq([ { server: 'www.abaqis.com', 
+                      use_ssl: true, 
+                      api_token: 'the_token',
+                      trace: false, 
+                      service_id: "234" }, # Default options
+                    'service', # Default resource
+                    'list' ]) # Default command
+        end
+
+        it "should the set the third party id" do
+          argv = ['--token', 'the_token', '--third-party-id', "234"]
+          expect(@cut.parse_options!(argv)).
+            to eq([ { server: 'www.abaqis.com', 
+                      use_ssl: true, 
+                      api_token: 'the_token',
+                      trace: false, 
+                      third_party_id: "234" }, # Default options
+                    'service', # Default resource
+                    'list' ]) # Default command
+        end
+
+      end
+
+    end
+
+    context '#invoke_command' do
+
+      it "should construct the resource with the options and invoke the command on the resource" do
+        @cut.should_receive(:parse_options!).
+          and_return( [ { }, 'service', 'list' ] )
+
+        mock_service = double("Service")
+        mock_service.should_receive(:send).
+          with(:list)
+        
+        Resources::Service.should_receive(:new).
+          with({}).
+          and_return(mock_service)
+
+        @cut.invoke_command
+      end
+
+    end
+  end
+
+  context 'Private Methods' do
+
+    context '#valid_command?' do
+
+      it "should return true if the specified resource has the specified command" do
+        COMMANDS.each_pair do | resource, commands |
+          commands.each do | command |
+            expect(@cut.send(:valid_command?, resource, command.to_s)).
+              to be_true, "'#{command}' should be a valid command for resource '#{resource}'"
+          end
+        end
+      end
+
+      it "should return false if the specified resource doesn't have the specified command" do
+        expect(@cut.send(:valid_command?, 'service', 'invalid_command')).
+          to be_false
+      end
+
+      it "should return false if the specified resource is nil" do
+        expect(@cut.send(:valid_command?, nil, 'list')).
+          to be_false
+      end
+
+      it "should return false if the specified command is nil" do
+        expect(@cut.send(:valid_command?, 'service', nil)).
+          to be_false
+      end
+
+      it "should do something horrible if the resource name is bogus" do
+        expect { @cut.send(:valid_command?, 'bottle', 'list') }.
+          to raise_error(NameError)
+      end
+
+    end
+
+    context '#valid_resource' do
+
+      it "should return true if the specified resource is valid" do
+        expect(@cut.send(:valid_resource?, 'service')).
+          to be_true
+      end
+
+      it "should return false if the specified resource is not valid" do
+        expect(@cut.send(:valid_resource?, 'servicer')).
+          to be_false
+      end
+
+      it "should return false if the specified resource is nil" do
+        expect(@cut.send(:valid_resource?, nil)).
+          to be_false
+      end
+
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,22 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+# Here's the deal. We need to make sure that the API_TOKEN is not set
+# environment before the tests are run. In fact, the ENV['API_TOKEN']
+# must be cleared before the ServiceMgrOptions class is loaded. That's 
+# why we do it before the requires.
+#
+# I'm just sayin'
+#
+ENV.delete('API_TOKEN')
+
+require 'rspec'
+require 'pvdgm-svc-client'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end

metadata

@@ -0,0 +1,202 @@
+--- !ruby/object:Gem::Specification
+name: pvdgm-svc-client
+version: !ruby/object:Gem::Version
+  version: 0.1.6
+platform: ruby
+authors:
+- Dave Sieh
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.2.14
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.2.14
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: terminal-table
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: highline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.7
+description: This gem provides command line and other types of tools to support the
+  Service Engine.
+email: dave.sieh@providigm.com
+executables:
+- service_mgr
+- service_mgr_completion
+- valid_commands
+- valid_resources
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+files:
+- ".document"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- bin/service_mgr
+- bin/service_mgr_completion
+- bin/valid_commands
+- bin/valid_resources
+- lib/pvdgm-svc-client.rb
+- lib/pvdgm-svc-client/base_resource.rb
+- lib/pvdgm-svc-client/prompters/account_mapping_prompter.rb
+- lib/pvdgm-svc-client/prompters/configured_account_prompter.rb
+- lib/pvdgm-svc-client/prompters/configured_facility_prompter.rb
+- lib/pvdgm-svc-client/prompters/facility_mapping_prompter.rb
+- lib/pvdgm-svc-client/prompters/public_key_prompter.rb
+- lib/pvdgm-svc-client/prompters/service_definition_prompter.rb
+- lib/pvdgm-svc-client/prompters/service_prompter.rb
+- lib/pvdgm-svc-client/prompters/sltc_provider_prompter.rb
+- lib/pvdgm-svc-client/prompters/sltc_registration_prompter.rb
+- lib/pvdgm-svc-client/prompters/third_party_prompter.rb
+- lib/pvdgm-svc-client/resources/account_mapping.rb
+- lib/pvdgm-svc-client/resources/assessment_request.rb
+- lib/pvdgm-svc-client/resources/available_file.rb
+- lib/pvdgm-svc-client/resources/configured_account.rb
+- lib/pvdgm-svc-client/resources/configured_facility.rb
+- lib/pvdgm-svc-client/resources/facility_mapping.rb
+- lib/pvdgm-svc-client/resources/mds_pull_account.rb
+- lib/pvdgm-svc-client/resources/provider.rb
+- lib/pvdgm-svc-client/resources/public_key.rb
+- lib/pvdgm-svc-client/resources/service.rb
+- lib/pvdgm-svc-client/resources/service_definition.rb
+- lib/pvdgm-svc-client/resources/sltc_registration.rb
+- lib/pvdgm-svc-client/resources/third_party.rb
+- lib/pvdgm-svc-client/service_mgr_options.rb
+- spec/base_resource_spec.rb
+- spec/service_mgr_options_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/GitHubAdmin/pvdgm-svc-client
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Command-line client tools to support the Service Engine
+test_files: []