resource_kit 0.0.5 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ee001caaa4f22885773d1f6e6ae076ec900762e2
-  data.tar.gz: b373c40127c0a4d7312ecea86ae634acd1ccbe85
+  metadata.gz: 4dba252d8a80b4ce9ecf96972dada6a221824b05
+  data.tar.gz: bb36d233fe0ae8e623b5f3c4c26a8a5dc74d2c81
 SHA512:
-  metadata.gz: dfcc677710aef8a376ac1d47e795b1267f2131ddd969f70352421b5b80788e7099a73dc04cba6282f5fe828ddc2f52ccc19e7856f0fbe591c8463381f4f89eb4
-  data.tar.gz: 987624fc56bb90b02ae917c91b8802fcc54697497b1776695fecd915d8b4e3f38dc73a98318bed5cebcc73b08c5c824c8a24f21e993324c8a2757277e0e17534
+  metadata.gz: 63d61a484700d8bacf02569c3fe4c9cb5942f8cfc37e3fa3689b29a980e2726d0f2b190a2ea24cc9907e1b03a70be95f825ebf47c83cbdc40863b8656f435fcb
+  data.tar.gz: 6f6b4d111147cf08a39c5a10a8114838cdffef0b45667e645690c5419f6b15ed2c5f96b353d35deda2fa386828f179514e530456ff08a4b7c06886af105fe957

data/README.md

@@ -31,26 +31,26 @@ When you're able to answer these questions, you can describe them in your resour
 ```ruby
 class DropletResource < ResourceKit::Resource
   resources do
-    default_handler(422) {|response| ErrorMapping.extract_single(response.body, :read) }
-    default_handler(:ok, :created) {|response| DropletMapping.extract_single(response.body, :read) }
+    default_handler(422) { |response| ErrorMapping.extract_single(response.body, :read) }
+    default_handler(:ok, :created) { |response| DropletMapping.extract_single(response.body, :read) }
 
     # Defining actions will create instance methods on the resource class to call them.
     action :find do
       verb :get # get is assumed if this is omitted
       path '/droplets/:id'
-      handler(200) {|response| DropletMapping.extract_single(response.body, :read) }
+      handler(200) { |response| DropletMapping.extract_single(response.body, :read) }
     end
 
     action :all do
       path '/droplets'
-      handler(200) {|body| DropletMapping.extract_collection(body, :read) }
+      handler(200) { |body| DropletMapping.extract_collection(body, :read) }
     end
 
     action :create do
       path '/droplets'
       verb :post
-      body {|object| DropletMapping.representation_for(:create, object) } # Generate a response body from a passed object
-      handler(202) {|response| DropletMapping.extract_single(response.body, :read) }
+      body { |object| DropletMapping.representation_for(:create, object) } # Generate a response body from a passed object
+      handler(202) { |response| DropletMapping.extract_single(response.body, :read) }
     end
   end
 end
@@ -86,6 +86,56 @@ single_droplet = resource.find(id: 123)
 create = resource.create(Droplet.new)
 ```
 
+## Scope
+
+ResourceKit classes give you the option to pass in an optional scope object, so that you may interact with the resource with it that way.
+
+For example, you may want to use this for nested resources:
+
+```ruby
+class CommentResource < ResourceKit::Resource
+  resources do
+    action :all do
+      path { "/users/#{user_id}/comments" }
+      handler(200) { |resp| CommentMapping.extract_collection(resp.body, :read) }
+    end
+  end
+
+  def user_id
+    scope.user_id
+  end
+end
+
+user = User.find(123)
+resource = CommentResource.new(connection, user)
+comments = resource.all #=> Will fetch from /users/123/comments
+```
+
+## Test Helpers
+
+ResourceKit supplys test helpers that assist in certain things you'd want your resource classes to do.
+
+Make sure you:
+
+    require 'resource_kit/testing'
+
+Testing a certain action:
+
+```ruby
+# Tag the spec with resource_kit to bring in the helpers
+RSpec.describe MyResourceClass, resource_kit: true do
+  it 'has an all action' do
+    expect(MyResourceClass).to have_action(:all).that_handles(:ok, :no_content).at_path('/users')
+  end
+
+  it 'handles a 201 with response body' do
+    expect(MyResourceClass).to handle_response(:create).with(status: 201, body: '{"users":[]}') do |handled|
+      expect(handled).to all(be_kind_of(User))
+    end
+  end
+end
+```
+
 ### Nice to have's
 
 Things we've thought about but just haven't implemented are:

data/examples/digitalocean_droplets.rb

@@ -36,7 +36,7 @@ class DropletResource < ResourceKit::Resource
     action :create do
       verb :post
       path '/v2/droplets'
-      body {|object| DropletMapping.representation_for(:create, object) }
+      body { |object| DropletMapping.representation_for(:create, object) }
       handler(202) { |response| DropletMapping.extract_single(response.body, :read) }
     end
   end

data/lib/resource_kit/action.rb

@@ -14,8 +14,10 @@ module ResourceKit
       @verb
     end
 
-    def path(path = nil)
+    def path(path = nil, &block)
+      raise "You must pass either a block or a string for paths" if path and block_given?
       @path = path if path
+      @path = block if block_given?
       @path
     end
 
@@ -41,5 +43,22 @@ module ResourceKit
       @body_handler = block if block_given?
       @body_handler
     end
+
+    def hooks
+      @hooks ||= {}
+    end
+
+    def before_request(method_name = nil, &block)
+      hooks[:before] ||= []
+
+      if block_given?
+        hooks[:before] << block
+      else
+        raise "Must include a method name" unless method_name
+        hooks[:before] << method_name
+      end
+
+      nil
+    end
   end
 end

data/lib/resource_kit/action_invoker.rb

@@ -1,21 +1,22 @@
 module ResourceKit
   class ActionInvoker
-    attr_reader :action, :connection, :args, :options
+    attr_reader :action, :connection, :args, :options, :resource
 
-    def initialize(action, connection, *args)
+    def initialize(action, resource, *args)
       @action = action
-      @connection = connection
+      @resource = resource
+      @connection = resource.connection
       @args = args
       @options = args.last.kind_of?(Hash) ? args.last : {}
     end
 
-    def self.call(action, connection, *args)
-      new(action, connection, *args).handle_response
+    def self.call(action, resource, *args)
+      new(action, resource, *args).handle_response
     end
 
     def handle_response
       if handler = action.handlers[response.status]
-        handler.call(response)
+        resource.instance_exec(response, &handler)
       else
         response.body
       end
@@ -30,18 +31,28 @@ module ResourceKit
 
       raise ArgumentError, "Verb '#{action.verb}' is not allowed" unless action.verb.in?(ALLOWED_VERBS)
 
-      if action.body and action.verb.in?([:post, :put, :patch])
-        # This request is going to have a response body. Handle it.
-        @response = connection.send(action.verb, resolver.resolve(options)) do |request|
-          request.body = construct_body
-        end
-      else
-        @response = connection.send(action.verb, resolver.resolve(options))
+      @response = connection.send(action.verb, resolver.resolve(options)) do |request|
+        request.body = construct_body if action.body and action.verb.in?([:post, :put, :patch])
+        append_hooks(:before, request)
       end
     end
 
     def resolver
-      EndpointResolver.new(path: action.path, query_param_keys: action.query_keys)
+      path = action.path.kind_of?(Proc) ? resource.instance_eval(&action.path) : action.path
+      EndpointResolver.new(path: path, query_param_keys: action.query_keys)
+    end
+
+    private
+
+    def append_hooks(hook_type, request)
+      (action.hooks[hook_type] || []).each do |hook|
+        case hook
+        when Proc
+          resource.instance_exec(*args, request, &hook)
+        when Symbol
+          resource.send(hook, *args, request)
+        end
+      end
     end
   end
 end

data/lib/resource_kit/method_factory.rb

@@ -13,7 +13,7 @@ module ResourceKit
 
     def self.method_for_action(action, invoker)
       Proc.new do |*args|
-        invoker.call(action, connection, *args)
+        invoker.call(action, self, *args)
       end
     end
   end

data/lib/resource_kit/resource.rb

@@ -2,17 +2,21 @@ module ResourceKit
   class Resource
     class_attribute :_resources
 
-    attr_reader :connection
+    attr_reader :connection, :scope
 
-    def initialize(connection)
+    def initialize(connection: nil, scope: nil)
       @connection = connection
+      @scope = scope
     end
 
     def self.resources(&block)
       self._resources ||= ResourceCollection.new
-      self._resources.instance_eval(&block) if block_given?
 
-      MethodFactory.construct(self, self._resources)
+      if block_given?
+        self._resources.instance_eval(&block)
+        MethodFactory.construct(self, self._resources)
+      end
+
       self._resources
     end
 

data/lib/resource_kit/resource_collection.rb

@@ -11,7 +11,7 @@ module ResourceKit
       action = Action.new(name, *parse_verb_and_path(verb_and_path))
       action.handlers.merge!(default_handlers.dup)
       action.instance_eval(&block) if block_given?
-      action.tap {|a| self << a }
+      action.tap { |a| self << a }
     end
 
     def default_handler(*response_codes, &block)

data/lib/resource_kit/status_code_mapper.rb

@@ -53,7 +53,7 @@ module ResourceKit
     }
 
     def self.code_for(symbol)
-      MAP[symbol]
+      MAP[symbol] || symbol
     end
   end
 end

data/lib/resource_kit/testing/action_handler_matchers.rb

@@ -0,0 +1,34 @@
+module ResourceKit
+  module Testing
+    class ActionHandlerMatchers
+      ResponseStub = Class.new(OpenStruct)
+
+      attr_reader :action, :response_stub
+
+      def initialize(action)
+        @action = action
+      end
+
+      def with(options, &block)
+        @response_stub = ResponseStub.new(options)
+        @handled_block = block
+
+        self
+      end
+
+      def matches?(subject, &block)
+        @handled_block ||= block
+        action = subject.resources.find_action(self.action)
+        return false unless action
+
+        status_code = response_stub.status || 200
+        return false unless action.handlers[status_code]
+
+        handled_response = action.handlers[status_code].call(response_stub)
+        @handled_block.call(handled_response)
+
+        true
+      end
+    end
+  end
+end

data/lib/resource_kit/testing/have_action_matchers.rb

@@ -0,0 +1,68 @@
+module ResourceKit
+  module Testing
+    class HaveActionMatchers
+      attr_reader :action, :path, :verb
+
+      def initialize(action)
+        @action = action
+      end
+
+      def that_handles(*codes)
+        codes.each do |code|
+          handler_codes << StatusCodeMapper.code_for(code)
+        end
+
+        self
+      end
+
+      def at_path(path)
+        @path = path
+        self
+      end
+
+      def with_verb(verb)
+        @verb = verb
+        self
+      end
+
+      def matches?(subject)
+        action = subject.resources.find_action(self.action)
+        return false unless action
+
+        %i(check_keys check_path check_verb).inject(true) do |rv, method_name|
+          break false unless send(method_name, action)
+          true
+        end
+      end
+
+      def handler_codes
+        @handler_codes ||= []
+      end
+
+      private
+
+      def check_keys(action)
+        keys = action.handlers.keys
+
+        if !handler_codes.empty?
+          handler_codes.each do |handler_code|
+            return false unless keys.include?(handler_code)
+          end
+        end
+
+        true
+      end
+
+      def check_path(action)
+        return true unless self.path
+        action.path == self.path
+      end
+
+      def check_verb(action)
+        return true unless self.verb
+        checked_verb = self.verb.kind_of?(String) ? self.verb.downcase.to_sym : self.verb
+        action.verb == checked_verb
+      end
+    end
+  end
+end

data/lib/resource_kit/testing.rb

@@ -0,0 +1,20 @@
+require 'resource_kit/testing/have_action_matchers'
+require 'resource_kit/testing/action_handler_matchers'
+
+module ResourceKit
+  module Testing
+    def have_action(action)
+      HaveActionMatchers.new(action)
+    end
+
+    def handle_response(action, &block)
+      ActionHandlerMatchers.new(action)
+    end
+  end
+end
+
+if defined?(RSpec)
+  RSpec.configure do |config|
+    config.include ResourceKit::Testing, resource_kit: true
+  end
+end

data/lib/resource_kit/version.rb

@@ -1,3 +1,3 @@
 module ResourceKit
-  VERSION = "0.0.5"
+  VERSION = "0.1.0"
 end

data/resource_kit.gemspec

@@ -12,6 +12,7 @@ Gem::Specification.new do |spec|
   spec.description   = ''
   spec.homepage      = "https://github.com/digitaloceancloud/resource_kit"
   spec.license       = "MIT"
+  spec.required_ruby_version = '>= 2.0'
 
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
@@ -26,5 +27,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "webmock", "~> 1.18.0"
-  spec.add_development_dependency "kartograph", "~> 0"
+  spec.add_development_dependency "kartograph", "~> 0.0.8"
+  spec.add_development_dependency "pry", "~> 0.10.1"
 end

data/spec/integration/resource_actions_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+class DummyResourceActions < ResourceKit::Resource
+  resources do
+    action :dummy, 'GET /dummy' do
+      handler(200) { |resp| resp.body.upcase }
+    end
+
+    action :headered, 'GET /headered' do
+      before_request { |req| req.headers['Added-Header'] = self.value }
+    end
+  end
+
+  def value
+    scope.value
+  end
+end
+
+RSpec.describe 'Resource Actions' do
+  let(:connection) { Faraday.new { |b| b.adapter :test, stubs } }
+  let(:scoped) { double('scope', value: 'bunk') }
+  let(:stubs) do
+    Faraday::Adapter::Test::Stubs.new do |stub|
+      stub.get('/dummy') { |env| [200, {}, 'dummies'] }
+      stub.get('/headered') { |env| [200, {}, env[:request_headers]['Added-Header']] }
+    end
+  end
+
+  it 'Retrieving /dummy returns the body as uppercased' do
+    resource = DummyResourceActions.new(connection: connection, scope: scoped)
+    response = resource.dummy
+    expect(response).to eq('DUMMIES')
+  end
+
+  it 'adds the header before the request happens' do
+    resource = DummyResourceActions.new(connection: connection, scope: scoped)
+    response = resource.headered
+
+    expect(response).to eq(scoped.value)
+  end
+end

data/spec/lib/resource_kit/action_invoker_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 RSpec.describe ResourceKit::ActionInvoker do
-  let(:connection) { Faraday.new {|b| b.adapter :test, stubs } }
+  let(:connection) { Faraday.new { |b| b.adapter :test, stubs } }
   let(:stubs) do
     Faraday::Adapter::Test::Stubs.new do |stub|
       stub.get('/users') { |env| [200, {}, 'all users'] }
@@ -9,25 +9,35 @@ RSpec.describe ResourceKit::ActionInvoker do
       stub.get('/users/12') { |env| [200, {}, 'user 12'] }
       stub.post('/users') { |env| [200, {}, env[:body]] }
       stub.get('/paged') { |env| [200, {}, env[:url].to_s] }
+      stub.get('/before_hooks') { |env| [200, {}, env[:request_headers]['Owner-Id']] }
+      stub.get('/block_based') { |env| [200, {}, 'block based path'] }
     end
   end
   let(:action) { ResourceKit::Action.new(:find) }
+  let(:resource) { double('resource instance', connection: connection) }
 
   describe '.call' do
     it 'performs a request to the specfied URL' do
       action.verb :get
       action.path '/users'
 
-      result = ResourceKit::ActionInvoker.call(action, connection)
+      result = ResourceKit::ActionInvoker.call(action, resource)
 
       expect(result).to eq('all users')
     end
 
+    it 'performs a request to the correct url when using a block for path' do
+      action.path { '/block_based' }
+      result = ResourceKit::ActionInvoker.call(action, resource)
+
+      expect(result).to eq('block based path')
+    end
+
     it 'substitues params on call' do
       action.verb :get
       action.path '/users/:id'
 
-      result = ResourceKit::ActionInvoker.call(action, connection, id: 12)
+      result = ResourceKit::ActionInvoker.call(action, resource, id: 12)
       expect(result).to eq('user 12')
     end
 
@@ -35,9 +45,9 @@ RSpec.describe ResourceKit::ActionInvoker do
       it 'returns the handler block' do
         action.verb :get
         action.path '/users'
-        action.handler(200) {|response| 'changed' }
+        action.handler(200) { |response| 'changed' }
 
-        result = ResourceKit::ActionInvoker.call(action, connection)
+        result = ResourceKit::ActionInvoker.call(action, resource)
 
         expect(result).to eq('changed')
       end
@@ -45,9 +55,9 @@ RSpec.describe ResourceKit::ActionInvoker do
       it 'uses the correct handler on status codes' do
         action.verb :get
         action.path '/users/bad_page'
-        action.handler(404) {|response| '404ed' }
+        action.handler(404) { |response| '404ed' }
 
-        result = ResourceKit::ActionInvoker.call(action, connection)
+        result = ResourceKit::ActionInvoker.call(action, resource)
         expect(result).to eq('404ed')
       end
     end
@@ -56,18 +66,18 @@ RSpec.describe ResourceKit::ActionInvoker do
       it 'uses the body handler when present' do
         action.verb :post
         action.path '/users'
-        action.body {|object| 'i am a banana' }
+        action.body { |object| 'i am a banana' }
 
-        result = ResourceKit::ActionInvoker.call(action, connection, 'echo me')
+        result = ResourceKit::ActionInvoker.call(action, resource, 'echo me')
         expect(result).to eq('i am a banana')
       end
 
       it 'uses the body handler with multiple arity when present' do
         action.verb :post
         action.path '/users'
-        action.body {|first, second| first + second }
+        action.body { |first, second| first + second }
 
-        result = ResourceKit::ActionInvoker.call(action, connection, 'echo me', ' another')
+        result = ResourceKit::ActionInvoker.call(action, resource, 'echo me', ' another')
         expect(result).to eq('echo me another')
       end
     end
@@ -77,11 +87,61 @@ RSpec.describe ResourceKit::ActionInvoker do
         action.query_keys :per_page, :page
         action.path '/paged'
 
-        result = ResourceKit::ActionInvoker.call(action, connection, page: 3, per_page: 300)
+        result = ResourceKit::ActionInvoker.call(action, resource, page: 3, per_page: 300)
         addressed = Addressable::URI.parse(result)
 
         expect(addressed.query_values).to include('per_page' => '300', 'page' => '3')
       end
     end
+
+    context 'for actions that have before request hooks' do
+      it 'calls the before request with the request object' do
+        action.path '/before_hooks'
+        action.verb :get
+        action.before_request { |req| req.headers['Owner-Id'] = 'bojangles' }
+
+        result = ResourceKit::ActionInvoker.call(action, resource)
+        expect(result).to eq('bojangles')
+      end
+
+      it 'calls the before request with the request object and arguments' do
+        action.path '/before_hooks'
+        action.verb :get
+        action.before_request { |one, two, req| req.headers['Owner-Id'] = "#{one} #{two}" }
+
+        result = ResourceKit::ActionInvoker.call(action, resource, 'one', 'two')
+        expect(result).to eq('one two')
+      end
+
+      context 'for passing a symbol' do
+        it 'calls the method on the context of the action' do
+          def resource.kickit(request)
+            request.headers['Owner-Id'] = 'btabes'
+          end
+
+          action.path '/before_hooks'
+          action.verb :get
+          action.before_request(:kickit)
+
+          invoker = ResourceKit::ActionInvoker.new(action, resource)
+
+          expect(invoker.handle_response).to eq('btabes')
+        end
+
+        it 'calls the action with arguments passed' do
+          def resource.kickit(one, two, request)
+            request.headers['Owner-Id'] = "#{one} #{two}"
+          end
+
+          action.path '/before_hooks'
+          action.verb :get
+          action.before_request(:kickit)
+
+          invoker = ResourceKit::ActionInvoker.new(action, resource, 'bobby', 'tables')
+
+          expect(invoker.handle_response).to eq('bobby tables')
+        end
+      end
+    end
   end
 end

data/spec/lib/resource_kit/action_spec.rb

@@ -24,6 +24,14 @@ RSpec.describe ResourceKit::Action do
       action.path '/something/sammy'
       expect(action.path).to eq('/something/sammy')
     end
+
+    it 'sets the path to a block when passed' do
+      action = described_class.new(:find)
+      proc = Proc.new { '/users/:id/comments' }
+      action.path(&proc)
+
+      expect(action.path).to be(proc)
+    end
   end
 
   describe '#handler' do
@@ -46,7 +54,7 @@ RSpec.describe ResourceKit::Action do
 
   describe '#body' do
     it 'stores a proc for handling requests with bodies' do
-      handler = Proc.new {|object| 'whut whut' }
+      handler = Proc.new { |object| 'whut whut' }
       action.body(&handler)
 
       expect(action.body).to be(handler)
@@ -59,4 +67,21 @@ RSpec.describe ResourceKit::Action do
       expect(action.query_keys).to include(:per_page, :page)
     end
   end
+
+  describe '#before_request' do
+    context 'with a block' do
+      it 'sets a block to happen before the request happens' do
+        proc = Proc.new {}
+        action.before_request(&proc)
+        expect(action.hooks[:before]).to include(proc)
+      end
+    end
+
+    context 'with a symbol' do
+      it 'adds the symbol to the before hooks' do
+        action.before_request(:foo)
+        expect(action.hooks[:before]).to include(:foo)
+      end
+    end
+  end
 end

data/spec/lib/resource_kit/method_factory_spec.rb

@@ -44,7 +44,7 @@ RSpec.describe ResourceKit::MethodFactory do
       instance = klass.new
       instance.connection = double('connection')
       instance.bunk('something', 'something else')
-      expect(invoker).to have_received(:call).with(action, instance.connection, 'something', 'something else')
+      expect(invoker).to have_received(:call).with(action, instance, 'something', 'something else')
     end
   end
 end

data/spec/lib/resource_kit/resource_collection_spec.rb

@@ -5,7 +5,7 @@ RSpec.describe ResourceKit::ResourceCollection do
 
   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' }
+      handler_block = Proc.new { |b| 'whut whut' }
       collection.default_handler(:ok, :no_content, &handler_block)
 
       expect(collection.default_handlers[200]).to eq(handler_block)
@@ -15,7 +15,7 @@ RSpec.describe ResourceKit::ResourceCollection do
 
   describe '#action' do
     it 'yields an action to the block' do
-      expect {|b| collection.action(:all, &b) }.to yield_with_args(instance_of(ResourceKit::Action))
+      expect { |b| collection.action(:all, &b) }.to yield_with_args(instance_of(ResourceKit::Action))
     end
 
     it 'adds the action to the collection' do
@@ -31,7 +31,7 @@ RSpec.describe ResourceKit::ResourceCollection do
     end
 
     context 'when default handlers have been specified on the collection' do
-      let(:handler) { Proc.new {|response| 'sure' } }
+      let(:handler) { Proc.new { |response| 'sure' } }
 
       before { collection.default_handler(:ok, &handler) }
 

data/spec/lib/resource_kit/resource_spec.rb

@@ -20,7 +20,7 @@ RSpec.describe ResourceKit::Resource do
         end
       end
 
-      subject(:droplet_resource) { DropletResource.new(double) }
+      subject(:droplet_resource) { DropletResource.new }
 
       it "defines the action method" do
         expect(droplet_resource).to respond_to(:find)
@@ -31,10 +31,20 @@ RSpec.describe ResourceKit::Resource do
   describe '#initialize' do
     it 'initializes with a connection' do
       faraday = Faraday.new(url: 'http://lol.com')
-      instance = ResourceKit::Resource.new(faraday)
+      instance = ResourceKit::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 = ResourceKit::Resource.new(connection: connection, scope: scope)
+
+      expect(instance.connection).to be(connection)
+      expect(instance.scope).to be(scope)
+    end
   end
 
   describe '#action' do
@@ -47,7 +57,7 @@ RSpec.describe ResourceKit::Resource do
         end
       end
 
-      instance = DummyResource.new(faraday)
+      instance = DummyResource.new(connection: faraday)
 
       expect(instance.action(:find)).to be_kind_of(ResourceKit::Action)
     end

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

@@ -0,0 +1,40 @@
+require 'spec_helper'
+require 'json'
+
+RSpec.describe ResourceKit::Testing::ActionHandlerMatchers do
+  let(:resource_class) { Class.new(ResourceKit::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
+end

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

@@ -0,0 +1,108 @@
+require 'spec_helper'
+
+RSpec.describe ResourceKit::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(ResourceKit::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
+end

data/spec/spec_helper.rb

@@ -1,4 +1,6 @@
 require 'resource_kit'
+require 'resource_kit/testing'
+require 'pry'
 
 RSpec.configure do |config|
   config.order = :random

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: resource_kit
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.1.0
 platform: ruby
 authors:
 - Robert Ross
@@ -9,120 +9,134 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-06 00:00:00.000000000 Z
+date: 2014-08-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
   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: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
   name: addressable
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.3.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.3.6
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
 - !ruby/object:Gem::Dependency
   name: rake
   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.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.18.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.18.0
 - !ruby/object:Gem::Dependency
   name: kartograph
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.0.8
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.0.8
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.1
 description: ''
 email:
 - rross@digitalocean.com
@@ -131,8 +145,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
+- ".gitignore"
+- ".rspec"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -146,8 +160,12 @@ files:
 - lib/resource_kit/resource.rb
 - lib/resource_kit/resource_collection.rb
 - lib/resource_kit/status_code_mapper.rb
+- lib/resource_kit/testing.rb
+- lib/resource_kit/testing/action_handler_matchers.rb
+- lib/resource_kit/testing/have_action_matchers.rb
 - lib/resource_kit/version.rb
 - resource_kit.gemspec
+- spec/integration/resource_actions_spec.rb
 - spec/lib/resource_kit/action_invoker_spec.rb
 - spec/lib/resource_kit/action_spec.rb
 - spec/lib/resource_kit/endpoint_resolver_spec.rb
@@ -155,6 +173,8 @@ files:
 - spec/lib/resource_kit/resource_collection_spec.rb
 - spec/lib/resource_kit/resource_spec.rb
 - spec/lib/resource_kit/status_code_mapper_spec.rb
+- spec/lib/resource_kit/testing/action_handler_matchers_spec.rb
+- spec/lib/resource_kit/testing/have_action_matchers_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/digitaloceancloud/resource_kit
 licenses:
@@ -166,12 +186,12 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
@@ -182,6 +202,7 @@ specification_version: 4
 summary: Resource Kit 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_kit/action_invoker_spec.rb
 - spec/lib/resource_kit/action_spec.rb
 - spec/lib/resource_kit/endpoint_resolver_spec.rb
@@ -189,4 +210,6 @@ test_files:
 - spec/lib/resource_kit/resource_collection_spec.rb
 - spec/lib/resource_kit/resource_spec.rb
 - spec/lib/resource_kit/status_code_mapper_spec.rb
+- spec/lib/resource_kit/testing/action_handler_matchers_spec.rb
+- spec/lib/resource_kit/testing/have_action_matchers_spec.rb
 - spec/spec_helper.rb