mio-config 1.3.0

data/spec/lib/mio/client_spec.rb

@@ -0,0 +1,79 @@
+require 'spec_helper'
+
+describe 'Mio::Client' do
+  let(:mio_client){build :valid_client}
+  let(:mio_client_invalid_user){build :invalid_user_client}
+  let(:mio_client_invalid){build :invalid_client}
+
+  let(:create_payload){build(:create_json).to_h}
+  let(:configure_payload){ {'vfs-location' => build(:configure_json).to_h} }
+  let(:action_payload){build(:action_json).to_h}
+
+  context 'with correct credentials' do
+    let(:client){mio_client}
+    it_behaves_like 'simple_client'
+    it_behaves_like 'masteruser_masteruser_client'
+
+    context 'when searching for a resource' do
+      context 'with a valid resource' do
+        let(:resource){'resources'}
+
+        it '#find_all returns a Hashie::Mash' do
+          expect(client.find_all(resource)).to be_a(Hash)
+        end
+      end
+
+      context 'with an invalid resource' do
+        let(:resource){'no-such-resource'}
+
+        it '#find_all throws Mio::Client::LoadOfBollocks' do
+          expect{ client.find_all('no-such-resource') }.to raise_error(Mio::Client::LoadOfBollocks)
+        end
+      end
+    end
+
+    context 'when creating a valid resource' do
+      let(:resource){'resources'}
+
+      it 'successfully creates a new resource' do
+        expect(client.create(resource, create_payload)).to be_a(Hash)
+      end
+
+      it 'successfully configures a new resource' do
+        expect(client.configure(resource, 11113, configure_payload)).to be_a(Hash)
+      end
+
+      it 'successfully enables a new resource' do
+        expect(client.action(resource, 11113, action_payload)).to be_a(Hash)
+      end
+
+    end
+
+    context 'when creating an invalid resource' do
+      let(:resource){'no-such-resource'}
+
+      it 'successfully creates a new resource' do
+        expect{client.create(resource, create_payload)}.to raise_error(Mio::Client::LoadOfBollocks)
+      end
+
+      it 'successfully configures a new resource' do
+        expect{client.configure(resource, 0, configure_payload)}.to raise_error(Mio::Client::LoadOfBollocks)
+      end
+
+      it 'successfully enables a new resource' do
+        expect{client.action(resource, 0, action_payload)}.to raise_error(Mio::Client::LoadOfBollocks)
+      end
+
+    end
+  end
+
+  context 'with invalid credentials' do
+    let(:client){mio_client}
+    it_behaves_like 'simple_client'
+  end
+
+  context 'with an invalid @base_uri' do
+    let(:client){mio_client}
+    it_behaves_like 'simple_client'
+  end
+end

data/spec/lib/mio/config_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe Mio::Config do
+
+ let (:mio_config) {Mio::Config.new}
+   context 'when instantiating' do
+     it 'should create an instance of Mio::Config' do
+        expect(mio_config).to be_instance_of(Mio::Config)     
+     end
+   end    
+end 

data/spec/lib/mio/model/groovy_script_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe 'Mio::Model::GroovyScript' do
+  subject{ Mio::Model::GroovyScript}
+  let(:model_args){build(:groovy_script)}
+  let(:invalid_model_args){build(:groovy_script_invalid_data)}
+  let(:extra_model_args){build(:groovy_script_extra_data)}
+
+  it_behaves_like 'generic_model'
+  it_behaves_like 'model_with_config_hash'
+  it_behaves_like 'non_nested_model'
+
+end

data/spec/lib/mio/model/groovy_script_wait_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe 'Mio::Model::GroovyScriptWait' do
+  subject{ Mio::Model::GroovyScriptWait }
+  let(:model_args){build(:groovy_script_wait)}
+  let(:invalid_model_args){build(:groovy_script_wait_invalid_data)}
+  let(:extra_model_args){build(:groovy_script_wait_extra_data)}
+
+  it_behaves_like 'generic_model'
+  it_behaves_like 'model_with_config_hash'
+  it_behaves_like 'non_nested_model'
+
+end

data/spec/lib/mio/model/hotfolder_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe 'Mio::Model::Hotfolder' do
+  subject{ Mio::Model::Hotfolder }
+  let(:model_args){build(:hotfolder)}
+  let(:invalid_model_args){build(:hotfolder_invalid_data)}
+  let(:extra_model_args){build(:hotfolder_extra_data)}
+
+  it_behaves_like 'generic_model'
+  it_behaves_like 'model_with_config_hash'
+  it_behaves_like 'non_nested_model'
+
+end

data/spec/lib/mio/model/import_action_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe 'Mio::Model::ImportAction' do
+  subject{ Mio::Model::ImportAction }
+  let(:model_args){build(:import_action)}
+  let(:invalid_model_args){build(:import_action_invalid_data)}
+  let(:extra_model_args){build(:import_action_extra_data)}
+
+  it_behaves_like 'generic_model'
+  it_behaves_like 'model_with_config_hash'
+  it_behaves_like 'non_nested_model'
+
+end

data/spec/lib/mio/model/s3_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe 'Mio::Model::S3' do
+  subject{ Mio::Model::S3 }
+  let(:model_args){build(:s3)}
+  let(:invalid_model_args){build(:s3_invalid_data)}
+  let(:extra_model_args){build(:s3_extra_data)}
+
+  it_behaves_like 'generic_model'
+  it_behaves_like 'model_with_config_hash'
+  it_behaves_like 'non_nested_model'
+
+end

data/spec/lib/mio/model/workflow/node_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+describe 'Mio::Model::Workflow::Node' do
+  subject{ Mio::Model::Workflow::Node }
+  let(:model_args){build(:node)}
+  let(:invalid_model_args){build(:node_invalid_data)}
+  let(:extra_model_args){build(:node_extra_data)}
+  let(:action_model_args){build(:action_node)}
+
+  it_behaves_like 'generic_model'
+  it_behaves_like 'nested_model'
+
+  let(:client){build(:valid_client)}
+  let(:node_object){subject.new(client, model_args)}
+
+  it 'responds to #normalize_action' do
+    expect(node_object).to respond_to(:normalize_action)
+  end
+
+  context 'when adding a node without an action' do
+    let(:node_object){subject.new(client,build(:action_node))}
+    let(:node_hash){node_object.create_hash}
+
+    it 'creates a hash with an ACTION object' do
+      expect(node_hash).to include(:action)
+    end
+
+    [:id, :name, :pluginClass].each do |k|
+      it "creates an ACTION object with key #{k.to_s}" do
+        expect(node_hash[:action]).to include(k)
+      end
+    end
+  end
+
+end

data/spec/lib/mio/model/workflow/transition_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+describe 'Mio::Model::Workflow::Transition' do
+  subject{ Mio::Model::Workflow::Transition }
+  let(:model_args){build(:transition)}
+  let(:invalid_model_args){build(:transition_invalid_data)}
+  let(:extra_model_args){build(:transition_extra_data)}
+
+  it_behaves_like 'generic_model'
+  it_behaves_like 'nested_model'
+
+end

data/spec/lib/mio/model/workflow_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+describe 'Mio::Model::Workflow' do
+  subject{ Mio::Model::Workflow }
+  let(:model_args){build(:workflow)}
+  let(:invalid_model_args){build(:workflow_invalid_data)}
+  let(:extra_model_args){build(:workflow_extra_data)}
+
+  let(:empty_nodes){build(:workflow_empty_nodes)}
+  let(:empty_transitions){build(:workflow_empty_transitions)}
+
+  let(:client){build(:valid_client)}
+
+  it_behaves_like 'generic_model'
+  it_behaves_like 'non_nested_model'
+
+  context 'when instantiated with invalid options' do
+    %w{node transition}.each do |field|
+      let(:workflow){subject.new(client, build( "workflow_empty_#{field}s".to_sym ))}
+
+      context "when given an empty list of #{field}" do
+        it 'should raise a Mio::Model::EmptyField error' do
+          expect{workflow.go}.to raise_error(Mio::Model::EmptyField)
+        end
+      end
+    end
+  end
+
+  context 'when instantiated with valid options' do
+    let(:workflow){subject.new(client, model_args)}
+    [:structure_hash, :transition_lookup, :set_node_layouts].each do |m|
+      it "should respond to ##{m.to_s}" do
+        expect(workflow).to respond_to(m)
+      end
+    end
+  end
+
+end

data/spec/lib/mio/search_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+describe 'Mio::Search' do
+  let(:client){build :valid_client}
+  let(:searcher){Mio::Search.new(client)}
+
+  context 'when instantiated' do
+    it 'initialises correctly' do
+      expect(searcher).not_to be_nil
+    end
+  end
+
+  context 'delegating to #method_missing' do
+    it 'dynamically responds to #find_something_by_field' do
+      expect(searcher).to respond_to(:find_something_by_field)
+    end
+
+    it 'searches for resources by key correctly' do
+      expect(searcher.find_resources_by_name('vcr resource storage')).to be_an(Array)
+    end
+
+    context 'when regular expressions misses' do
+      it 'returns true correctly for registered methods' do
+        expect(searcher).to respond_to(:all)
+      end
+
+      it 'returns false for unregistered methods' do
+        expect(searcher).not_to respond_to(:i_am_a_fake_method)
+      end
+
+      it 'throws an error when calling an unregistered method' do
+        expect{ searcher.i_am_a_fake_method }.to raise_error(NoMethodError)
+      end
+    end
+
+  end
+end

data/spec/lib/mio_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+describe 'Mio' do
+  let(:mio){build :mio}
+
+  context 'when instantiating with args' do
+    it 'creates an object' do
+      expect(mio).not_to be_nil
+    end
+  end
+
+  context 'when instantiating with a block' do
+    let(:mio){Mio.new{|m| m.base_uri='example.com'; m.username='x'; m.password='x'}}
+    it 'creates an object' do
+      expect(mio).not_to be_nil
+    end
+  end
+
+  context 'when created' do
+    let(:client){mio.client}
+    it_behaves_like 'simple_client'
+    it_behaves_like 'masteruser_masteruser_client'
+
+    [:base_uri, :base_uri=, :username, :username=, :password, :password=, :client].each do |m|
+      it "responds to ##{m.to_s}" do
+        expect(mio).to respond_to(m)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+require 'simplecov'
+SimpleCov.start do
+  add_filter 'spec'
+end
+
+require 'factory_girl'
+require 'faker'
+require 'rspec'
+require 'vcr'
+
+require 'mio'
+
+%w{support factories}.each do |d|
+  Dir["./spec/#{d}/**/*.rb"].sort.each { |f| require f}
+end

data/spec/support/factory_girl.rb

@@ -0,0 +1,3 @@
+RSpec.configure do |config|
+  config.include FactoryGirl::Syntax::Methods
+end

data/spec/support/shared_examples_for_client.rb

@@ -0,0 +1,27 @@
+shared_examples 'simple_client' do
+  it 'instantiates' do
+    expect(client).not_to be_nil
+  end
+
+  it 'creates a faraday object' do
+    expect(client.instance_variable_get(:@agent)).to be_a(Faraday::Connection)
+  end
+
+  [:find_all, :create, :configure, :action].each do |public_method|
+    it "responds to ##{public_method}" do
+      expect(client).to respond_to(public_method)
+    end
+  end
+
+  [:get, :post, :put, :make_object, :path].each do |private_method|
+    it "has, but doesn't respond to, private method ##{private_method}" do
+      expect(client.private_methods).to include(private_method)
+    end
+  end
+end
+
+shared_examples 'masteruser_masteruser_client' do
+  it 'configures basic auth correctly' do
+    expect(client.instance_variable_get(:@agent).headers['Authorization']).to eql 'Basic bWFzdGVydXNlcjptYXN0ZXJ1c2Vy'
+  end
+end

data/spec/support/shared_examples_for_model.rb

@@ -0,0 +1,87 @@
+shared_examples 'generic_model' do
+  context 'when interrogating the class object' do
+    [:set_resource, :field, :mappings, :fields, :fields=, :resource_name, :resource_name=].each do |m|
+      it "responds to public method ##{m.to_s}" do
+        expect(subject).to respond_to(m)
+      end
+    end
+
+    it 'correctly loads self into mappings' do
+      expect(subject.mappings.values).to include(subject)
+    end
+  end
+
+  context 'when creating an object' do
+    let(:client){build :valid_client}
+    let(:valid_model){subject.new(client, model_args)}
+
+    it 'instantiates' do
+      expect(valid_model).not_to be_nil
+    end
+
+    [:create_hash].each do |m|
+      it "provides a hash from ##{m}" do
+        expect(valid_model.method(m).call).to be_an(Hash)
+      end
+    end
+
+    context 'when validating configuration' do
+      let(:empty_model){subject.new(client, {})}
+      let(:bad_data){subject.new(client, invalid_model_args)}
+      let(:extra_data){subject.new(client, extra_model_args)}
+
+      it 'returns true for #valid? for valid configuration' do
+        expect(valid_model.valid?).to be true
+      end
+
+      it 'throws Mio::Model::MissingField when configuration misses a required field' do
+        expect{empty_model.valid?}.to raise_error(Mio::Model::MissingField)
+      end
+
+      it 'throws Mio::Model::DataTypeError when configuration contains a bad data type' do
+        expect{bad_data.valid?}.to raise_error(Mio::Model::DataTypeError)
+      end
+
+      it 'throws Mio::Model::NoSuchField when configuration contains unexpected data' do
+        expect{extra_data.valid?}.to raise_error(Mio::Model::NoSuchField)
+      end
+
+    end
+  end
+end
+
+shared_examples 'model_with_config_hash' do
+  let(:client){build :valid_client}
+  let(:valid_model){subject.new(client, model_args)}
+
+  [:config_hash].each do |m|
+    it "provides a hash from ##{m}" do
+      expect(valid_model.method(m).call).to be_an(Hash)
+    end
+  end
+end
+
+shared_examples 'nested_model' do
+  let(:client){build :valid_client}
+  let(:valid_model){subject.new(client, model_args)}
+
+  it "returns true for #nested?" do
+    expect(subject.nested?).to be(true)
+  end
+end
+
+shared_examples 'non_nested_model' do
+  let(:client){build :valid_client}
+  let(:valid_model){subject.new(client, model_args)}
+
+  it "returns false for #nested?" do
+    expect(subject.nested?).to be(false)
+  end
+
+  context 'when creating a mio resource' do
+    it 'Goes through the complete flow with #go' do
+      expect(valid_model.go).to be_a(Hash)
+    end
+  end
+
+end