resource_kit 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6271c0e0f56abd845d9067c8bc2e55597a532fcd
-  data.tar.gz: 4898d65f961b2be6121c782efd92fbfd2f153660
+  metadata.gz: 8bc66e1b067e94ec5db09d088e37cce2fb5a82f8
+  data.tar.gz: bb016cd88ad60b8d4e4579097baeeec5cd2aab27
 SHA512:
-  metadata.gz: 1bb8f7fea234fabc6d235eb4a9d3f1829d685b72dad2fe737986fee2dd2a432f9b59d91563fbcde239dbcfe802ec2df4614543b22fd9838ab241163d49b102ea
-  data.tar.gz: e78e93b61f9301dea5c86db6c3aa219794ff33fab4ad97da122a393d3ee3ecde093ddc34f751c80c8fd3f79405b860a7254b8026dff4571473ee6307889b0d0f
+  metadata.gz: 5e2d1b07c54d0a11b6af5a1449965451d7496de420b97084c46e9c96967042364ac3534e4668e2665da284d904900012d4add6a1307e4a8c0588860f3b85883d
+  data.tar.gz: f3ec8aeee8be01c5aaa3341abddce355c5267a8d1f2e1bbad79dadc8a2cb102b45dcb4e4cb7a206b2b8cd3de60f12fcb46105078f1060b6cdeb7de7cc50072d6

data/README.md

@@ -56,6 +56,18 @@ class DropletResource < ResourceKit::Resource
 end
 ```
 
+You also have the option to use a shorter version to describe actions like this:
+
+```ruby
+class DropletResource < ResourceKit::Resource
+  resources do
+    action :all, 'GET /v2/droplets' do
+      handler(:ok) { |response| DropletMapping.extract_collection(response.body, :read) }
+    end
+  end
+end
+```
+
 Now that we've described our resources. We can instantiate our class with a connection object. ResourceKit relies on the interface that Faraday provides. For example:
 
 ```ruby

data/lib/resource_kit.rb

@@ -3,6 +3,8 @@ require 'active_support/core_ext'
 require 'faraday'
 
 module ResourceKit
+  ALLOWED_VERBS = [:get, :post, :put, :delete, :head, :patch, :options]
+
   autoload :Resource, 'resource_kit/resource'
   autoload :ResourceCollection, 'resource_kit/resource_collection'
 

data/lib/resource_kit/action.rb

@@ -2,8 +2,10 @@ module ResourceKit
   class Action
     attr_reader :name
 
-    def initialize(name)
+    def initialize(name, verb = nil, path = nil)
       @name = name
+      @verb = (verb && verb.downcase.to_sym) || :get
+      @path = path
     end
 
     def verb(v = nil)

data/lib/resource_kit/action_invoker.rb

@@ -1,16 +1,14 @@
 module ResourceKit
   class ActionInvoker
-    ALLOWED_VERBS = [:get, :post, :put, :delete, :head, :patch, :options]
-
     def self.call(action, connection, *args)
       raise ArgumentError, "Verb '#{action.verb}' is not allowed" unless action.verb.in?(ALLOWED_VERBS)
-      options = args.extract_options!
+      options = args.last.kind_of?(Hash) ? args.last : {}
       resolver = EndpointResolver.new(path: action.path)
 
-      if args.size > 0 and action.verb.in?([:post, :put, :patch])
+      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(args.first, action)
+          request.body = construct_body(*args, action)
         end
       else
         response = connection.send(action.verb, resolver.resolve(options))
@@ -27,12 +25,8 @@ module ResourceKit
       end
     end
 
-    def self.construct_body(object, action)
-      if action.body
-        action.body.call(object)
-      else
-        object.to_s
-      end
+    def self.construct_body(*args, action)
+      action.body.call(*args[0..(action.body.arity - 1)])
     end
   end
 end

data/lib/resource_kit/resource_collection.rb

@@ -7,16 +7,40 @@ module ResourceKit
       @collection = []
     end
 
-    def action(name, &block)
-      action = Action.new(name)
+    def action(name, verb_and_path = nil, &block)
+      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 }
     end
 
+    def default_handler(*response_codes, &block)
+      response_codes.each do |code|
+        unless code.is_a?(Fixnum)
+          code = StatusCodeMapper.code_for(code)
+        end
+        default_handlers[code] = block
+      end
+    end
+
+    def default_handlers
+      @default_handlers ||= {}
+    end
+
     def find_action(name)
       find do |action|
         action.name == name
       end
     end
+
+    private
+
+    def parse_verb_and_path(verb_and_path)
+      return [] unless verb_and_path
+      regex = /(?<verb>GET|POST|HEAD|PUT|PATCH|DELETE|OPTIONS)?\s*(?<path>.+)?/i
+      matched = verb_and_path.match(regex)
+
+      return matched[:verb], matched[:path]
+    end
   end
 end

data/lib/resource_kit/version.rb

@@ -1,3 +1,3 @@
 module ResourceKit
-  VERSION = "0.0.1"
+  VERSION = "0.0.3"
 end

data/resource_kit.gemspec

@@ -6,11 +6,11 @@ require 'resource_kit/version'
 Gem::Specification.new do |spec|
   spec.name          = "resource_kit"
   spec.version       = ResourceKit::VERSION
-  spec.authors       = ["Robert Ross"]
-  spec.email         = ["rross@digitalocean.com"]
+  spec.authors       = ["Robert Ross", "Ivan Vanderbyl"]
+  spec.email         = ["rross@digitalocean.com", "ivan@digitalocean.com"]
   spec.summary       = %q{Resource Kit provides tools to aid in making API Clients. Such as URL resolving, Request / Response layer, and more.}
   spec.description   = ''
-  spec.homepage      = ""
+  spec.homepage      = "https://github.com/digitaloceancloud/resource_kit"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0")

data/spec/lib/resource_kit/action_invoker_spec.rb

@@ -52,21 +52,22 @@ RSpec.describe ResourceKit::ActionInvoker do
     end
 
     context 'for requests with bodies' do
-      it 'includes the contents of the body in the request' do
+      it 'uses the body handler when present' do
         action.verb :post
         action.path '/users'
+        action.body {|object| 'i am a banana' }
 
         result = ResourceKit::ActionInvoker.call(action, connection, 'echo me')
-        expect(result).to eq('echo me')
+        expect(result).to eq('i am a banana')
       end
 
-      it 'uses the body handler when present' do
+      it 'uses the body handler with multiple arity when present' do
         action.verb :post
         action.path '/users'
-        action.body {|object| 'i am a banana' }
+        action.body {|first, second| first + second }
 
-        result = ResourceKit::ActionInvoker.call(action, connection, 'echo me')
-        expect(result).to eq('i am a banana')
+        result = ResourceKit::ActionInvoker.call(action, connection, 'echo me', ' another')
+        expect(result).to eq('echo me another')
       end
     end
   end

data/spec/lib/resource_kit/resource_collection_spec.rb

@@ -3,6 +3,16 @@ require 'spec_helper'
 RSpec.describe ResourceKit::ResourceCollection do
   subject(:collection) { ResourceKit::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
+  end
+
   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))
@@ -12,6 +22,24 @@ RSpec.describe ResourceKit::ResourceCollection 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' } }
+
+      before { collection.default_handler(:ok, &handler) }
+
+      it 'prepends the default handlers to the test' do
+        action = collection.action(:all)
+        expect(action.handlers[200]).to eq(handler)
+      end
+    end
   end
 
   describe '#find_action' do

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: resource_kit
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
 platform: ruby
 authors:
 - Robert Ross
+- Ivan Vanderbyl
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-02 00:00:00.000000000 Z
+date: 2014-08-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -125,6 +126,7 @@ dependencies:
 description: ''
 email:
 - rross@digitalocean.com
+- ivan@digitalocean.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -154,7 +156,7 @@ files:
 - spec/lib/resource_kit/resource_spec.rb
 - spec/lib/resource_kit/status_code_mapper_spec.rb
 - spec/spec_helper.rb
-homepage: ''
+homepage: https://github.com/digitaloceancloud/resource_kit
 licenses:
 - MIT
 metadata: {}