resource_set 1.0.0

data/spec/lib/resource_set/resource_collection_spec.rb

@@ -0,0 +1,67 @@
+require 'spec_helper'
+
+RSpec.describe ResourceSet::ResourceCollection do
+  subject(:collection) { ResourceSet::ResourceCollection.new }
+
+  describe '#default_handler' do
+    it 'adds the passed black to a hash of handlers on the resource collection' do
+      handler_block = Proc.new { |b| 'whut whut' }
+      collection.default_handler(:ok, :no_content, &handler_block)
+
+      expect(collection.default_handlers[200]).to eq(handler_block)
+      expect(collection.default_handlers[204]).to eq(handler_block)
+    end
+
+    it 'provides a top-level default handler if no status code is provided' do
+      handler_block = Proc.new { true }
+      collection.default_handler(&handler_block)
+
+      expect(collection.default_handlers[:any]).to eq(handler_block)
+    end
+  end
+
+  describe '#action' do
+    it 'yields an action to the block' do
+      expect { |b| collection.action(:all, &b) }.to yield_with_args(instance_of(ResourceSet::Action))
+    end
+
+    it 'adds the action to the collection' do
+      action = collection.action :all
+      expect(collection).to include(action)
+    end
+
+    it "accepts a second argument of VERB /resource" do
+      action = collection.action :all, 'GET /v2/droplets'
+      expect(action.verb).to eq :get
+      expect(action.path).to eq '/v2/droplets'
+      expect(action.name).to eq :all
+    end
+
+    context 'when default handlers have been specified on the collection' do
+      let(:handler) { Proc.new { |response| 'sure' } }
+      let(:default_handler) { Proc.new { 'Something unexpected happened!' } }
+
+      before do
+        collection.default_handler(:ok, &handler)
+        collection.default_handler(&default_handler)
+      end
+
+      it 'prepends the default handlers to the test' do
+        action = collection.action(:all)
+        expect(action.handlers[200]).to eq(handler)
+        expect(action.handlers[:any]).to eq(default_handler)
+      end
+    end
+  end
+
+  describe '#find_action' do
+    it 'returns the action with the name passed' do
+      collection.action(:all)
+
+      retrieved_action = collection.find_action(:all)
+
+      expect(retrieved_action).to be_kind_of(ResourceSet::Action)
+      expect(retrieved_action.name).to eq(:all)
+    end
+  end
+end

data/spec/lib/resource_set/resource_spec.rb

@@ -0,0 +1,66 @@
+require 'spec_helper'
+
+RSpec.describe ResourceSet::Resource do
+  describe '.resources' do
+    subject(:resource) { Class.new(described_class) }
+
+    it 'returns a resource collection' do
+      expect(resource.resources).to be_kind_of(ResourceSet::ResourceCollection)
+    end
+
+    it 'yields a resource collection' do
+      expect { |b| resource.resources(&b) }.to yield_with_args(instance_of(ResourceSet::ResourceCollection))
+    end
+
+    context 'action methods' do
+      class DropletResource < described_class
+        resources do
+          action :find
+          action :all
+        end
+      end
+
+      subject(:droplet_resource) { DropletResource.new }
+
+      it "defines the action method" do
+        expect(droplet_resource).to respond_to(:find)
+        expect(droplet_resource).to respond_to(:all)
+      end
+    end
+  end
+
+  describe '#initialize' do
+    it 'initializes with a connection' do
+      faraday = Faraday.new(url: 'http://lol.com')
+      instance = ResourceSet::Resource.new(connection: faraday)
+
+      expect(instance.connection).to be(faraday)
+    end
+
+    it 'initializes with an optional scope object' do
+      connection = double('conn')
+      scope = double('scope')
+
+      instance = ResourceSet::Resource.new(connection: connection, scope: scope)
+
+      expect(instance.connection).to be(connection)
+      expect(instance.scope).to be(scope)
+    end
+  end
+
+  describe '#action' do
+    it 'returns the action for the name passed' do
+      faraday = Faraday.new(url: 'http://lol.com')
+
+      class DummyResource < described_class
+        resources do
+          action :find, 'GET /hello'
+        end
+      end
+
+      instance = DummyResource.new(connection: faraday)
+
+      expect(instance.action(:find)).to be_kind_of(ResourceSet::Action)
+    end
+  end
+end

data/spec/lib/resource_set/status_code_mapper_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+
+RSpec.describe ResourceSet::StatusCodeMapper do
+  describe '.code_for' do
+    it 'returns the status code for a symbol' do
+      expect(described_class.code_for(:ok)).to eq(200)
+    end
+  end
+end

data/spec/lib/resource_set/testing/action_handler_matchers_spec.rb

@@ -0,0 +1,68 @@
+require 'spec_helper'
+require 'json'
+
+RSpec.describe ResourceSet::Testing::ActionHandlerMatchers do
+  let(:resource_class) { Class.new(ResourceSet::Resource) }
+  subject(:matcher) { described_class.new(:all) }
+
+  describe '#initialize' do
+    it 'initializes with a resource class' do
+      action = :all
+      instance = described_class.new(action)
+      expect(instance.action).to be(action)
+    end
+  end
+
+  describe '#with' do
+    it 'sets the passed response params' do
+      matcher.with(status: 200, body: 'Hello World')
+      expect(matcher.response_stub.status).to eq(200)
+      expect(matcher.response_stub.body).to eq('Hello World')
+    end
+  end
+
+  describe '#matches?' do
+    it 'matches when the resource handles the block correctly' do
+      resource_class.resources.action :all, 'GET /all' do
+        handler(200) { |response| JSON.load(response.body) }
+      end
+
+      change_var = nil
+      matcher.with(status: 200, body: '{"hello": "world"}') do |handled|
+        expect(handled['hello']).to eq('world')
+        change_var = true
+      end
+
+      expect(matcher.matches?(resource_class)).to be_truthy
+      expect(change_var).to be(true)
+    end
+  end
+
+  describe '#failure_message' do
+    context "when the matchers doesnt handle the same status code" do
+      it 'returns "expected the #{status_code} status code to be handled by the class."' do
+        resource_class.resources.action :all, 'GET /all' do
+          handler(200) { |response| JSON.load(response.body) }
+        end
+
+        matcher.with(status: 201, body: '{"Hello": "World"}')
+        matcher.matches?(resource_class) { }
+
+        expect(matcher.failure_message).to eq('expected the 201 status code to be handled by the class.')
+      end
+    end
+
+    context "when the matchers doesnt handle the same status code" do
+      it 'returns "expected the #{status_code} status code to be handled by the class."' do
+        resource_class.resources.action :show, 'GET /all' do
+          handler(200) { |response| JSON.load(response.body) }
+        end
+
+        matcher.with(status: 200, body: '{"Hello": "World"}')
+        matcher.matches?(resource_class) { }
+
+        expect(matcher.failure_message).to eq('expected :all to be handled by the class.')
+      end
+    end
+  end
+end

data/spec/lib/resource_set/testing/have_action_matchers_spec.rb

@@ -0,0 +1,157 @@
+require 'spec_helper'
+
+RSpec.describe ResourceSet::Testing::HaveActionMatchers do
+  describe '#initialize' do
+    it 'initializes with a resource class' do
+      action = :all
+      instance = described_class.new(action)
+      expect(instance.action).to be(action)
+    end
+  end
+
+  describe '#that_handles' do
+    subject(:testing_matcher) { described_class.new(:all) }
+
+    it 'returns itself' do
+      expect(testing_matcher.that_handles(200)).to be(testing_matcher)
+    end
+
+    it 'accepts a status code' do
+      testing_matcher.that_handles(200)
+      expect(testing_matcher.handler_codes).to include(200)
+    end
+
+    it 'accepts a magic status code' do
+      testing_matcher.that_handles(:ok)
+      expect(testing_matcher.handler_codes).to include(200)
+    end
+
+    it 'accepts multiple status codes' do
+      testing_matcher.that_handles(:ok, 201)
+      expect(testing_matcher.handler_codes).to include(200, 201)
+    end
+  end
+
+  describe '#at_path' do
+    subject(:testing_matcher) { described_class.new(:all) }
+
+    it 'sets the path we\'re specing' do
+      testing_matcher.at_path('/hello')
+      expect(testing_matcher.path).to eq('/hello')
+    end
+
+    it 'returns itself' do
+      expect(testing_matcher.at_path('/')).to be(testing_matcher)
+    end
+  end
+
+  describe '#with_verb' do
+    subject(:testing_matcher) { described_class.new(:all) }
+
+    it 'sets the verb to test for' do
+      testing_matcher.with_verb('POST')
+      expect(testing_matcher.verb).to eq('POST')
+    end
+  end
+
+  describe '#matches?' do
+    subject(:testing_matcher) { described_class.new(:all) }
+
+    context 'for a resource that has the defined action' do
+      let(:resource_class) { Class.new(ResourceSet::Resource) }
+
+      it 'matches with both code and path' do
+        resource_class.resources do
+          action :all, 'GET /hello' do
+            handler(200) { }
+          end
+        end
+
+        matcher = described_class.new(:all)
+        matcher.that_handles(:ok).at_path('/hello').with_verb('GET')
+
+        expect(matcher.matches?(resource_class)).to be_truthy
+      end
+
+      it 'matches with only code' do
+        resource_class.resources do
+          action :all, 'GET /hello' do
+            handler(200) { }
+          end
+        end
+
+        matcher = described_class.new(:all)
+        matcher.that_handles(:ok)
+
+        expect(matcher.matches?(resource_class)).to be_truthy
+      end
+
+      it 'matches with only path' do
+        resource_class.resources { action :all, 'GET /hello' }
+
+        matcher = described_class.new(:all)
+        matcher.at_path('/hello')
+
+        expect(matcher.matches?(resource_class)).to be_truthy
+      end
+
+      it 'matches with only the verb' do
+        resource_class.resources { action :all, 'GET /hello' }
+
+        matcher = described_class.new(:all)
+        matcher.with_verb('GET')
+
+        expect(matcher.matches?(resource_class)).to be_truthy
+      end
+    end
+  end
+
+  describe '#failure_message' do
+    let(:resource_class) {
+      Class.new(ResourceSet::Resource) { |resource|
+        resource.resources {
+          action :all, 'POST valid_path' do
+            handler(201)
+          end
+        }
+      }
+    }
+
+    context 'when the matcher doesnt find the action' do
+      it 'returns "expected class to have action #{action}".' do
+        matcher = described_class.new(:all)
+        expect(matcher.failure_message).to eq('expected class to have action all.')
+      end
+    end
+
+    context 'when the matcher doesnt find the path' do
+      it 'returns "expected #{expected} path, got #{gotten_value} instead".' do
+        matcher = described_class.new(:all)
+        matcher.at_path('invalid_path')
+        matcher.matches?(resource_class)
+
+        expect(matcher.failure_message).to eq('expected invalid_path path, got valid_path instead.')
+      end
+    end
+
+    context 'when the matcher doesnt find the status code' do
+      it 'returns "expected #{expected} status_code, got #{gotten_value} instead".' do
+        matcher = described_class.new(:all)
+        matcher.that_handles(:ok)
+        matcher.matches?(resource_class)
+
+        expect(matcher.failure_message).to eq('expected 200 status_code, got [201] instead.')
+      end
+    end
+
+    context 'when the matcher doesnt find the verb code' do
+      it 'returns "expected #{expected} verb, got #{gotten_value} instead".' do
+        matcher = described_class.new(:all)
+        matcher.with_verb(:get)
+        matcher.matches?(resource_class)
+
+        expect(matcher.failure_message).to eq('expected get verb, got post instead.')
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'resource_set'
+require 'resource_set/testing'
+require 'pry'
+require 'faraday'
+
+RSpec.configure do |config|
+  config.order = :random
+end

metadata

@@ -0,0 +1,202 @@
+--- !ruby/object:Gem::Specification
+name: resource_set
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Robert Ross
+- Ivan Vanderbyl
+- Kyrylo Silin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-09-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.3.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.3.6
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: cartograph
+  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: pry
+  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'
+description: ''
+email:
+- engineering@digitalocean.com
+- rross@digitalocean.com
+- ivan@digitalocean.com
+- silin@kyrylo.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- examples/digitalocean_droplets.rb
+- examples/httpbin_client.rb
+- lib/resource_set.rb
+- lib/resource_set/action.rb
+- lib/resource_set/action_invoker.rb
+- lib/resource_set/endpoint_resolver.rb
+- lib/resource_set/inheritable_attribute.rb
+- lib/resource_set/method_factory.rb
+- lib/resource_set/resource.rb
+- lib/resource_set/resource_collection.rb
+- lib/resource_set/status_code_mapper.rb
+- lib/resource_set/testing.rb
+- lib/resource_set/testing/action_handler_matchers.rb
+- lib/resource_set/testing/have_action_matchers.rb
+- lib/resource_set/version.rb
+- resource_set.gemspec
+- spec/integration/resource_actions_spec.rb
+- spec/lib/resource_set/action_invoker_spec.rb
+- spec/lib/resource_set/action_spec.rb
+- spec/lib/resource_set/endpoint_resolver_spec.rb
+- spec/lib/resource_set/inheritable_attribute_spec.rb
+- spec/lib/resource_set/method_factory_spec.rb
+- spec/lib/resource_set/resource_collection_spec.rb
+- spec/lib/resource_set/resource_spec.rb
+- spec/lib/resource_set/status_code_mapper_spec.rb
+- spec/lib/resource_set/testing/action_handler_matchers_spec.rb
+- spec/lib/resource_set/testing/have_action_matchers_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/kyrylo/resource_set
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.8
+signing_key: 
+specification_version: 4
+summary: Resource Set provides tools to aid in making API Clients. Such as URL resolving,
+  Request / Response layer, and more.
+test_files:
+- spec/integration/resource_actions_spec.rb
+- spec/lib/resource_set/action_invoker_spec.rb
+- spec/lib/resource_set/action_spec.rb
+- spec/lib/resource_set/endpoint_resolver_spec.rb
+- spec/lib/resource_set/inheritable_attribute_spec.rb
+- spec/lib/resource_set/method_factory_spec.rb
+- spec/lib/resource_set/resource_collection_spec.rb
+- spec/lib/resource_set/resource_spec.rb
+- spec/lib/resource_set/status_code_mapper_spec.rb
+- spec/lib/resource_set/testing/action_handler_matchers_spec.rb
+- spec/lib/resource_set/testing/have_action_matchers_spec.rb
+- spec/spec_helper.rb