resource_kit 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4dba252d8a80b4ce9ecf96972dada6a221824b05
-  data.tar.gz: bb36d233fe0ae8e623b5f3c4c26a8a5dc74d2c81
+  metadata.gz: b5b4f9ef92b9859bec0fff18766087660f650fe1
+  data.tar.gz: 365c6e38731eae50c87eb11f7d225daa364e29de
 SHA512:
-  metadata.gz: 63d61a484700d8bacf02569c3fe4c9cb5942f8cfc37e3fa3689b29a980e2726d0f2b190a2ea24cc9907e1b03a70be95f825ebf47c83cbdc40863b8656f435fcb
-  data.tar.gz: 6f6b4d111147cf08a39c5a10a8114838cdffef0b45667e645690c5419f6b15ed2c5f96b353d35deda2fa386828f179514e530456ff08a4b7c06886af105fe957
+  metadata.gz: fc1e6f8e169f2bf93da9e32019a525ac8374bda740266a482d95164456315a4495160ca5715761a0d978ea2f1ab5577b93a7f3ce7037c1c9442540afab59299d
+  data.tar.gz: f06860e9f4bf4789bfd7865c61e2977239f73d9a69f1cd7f2933381f0a8d9ce80c36957ddcb7e8d40ac335dd3438d18a50dc60a28e6d3604f3c28461eaaea69e

data/README.md

@@ -33,6 +33,7 @@ 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 { |response| raise "Unexpected response status #{response.status}... #{response.body}" }
 
     # Defining actions will create instance methods on the resource class to call them.
     action :find do
@@ -68,14 +69,26 @@ class DropletResource < ResourceKit::Resource
 end
 ```
 
+Instead of using `#action`, you can use any of the supported HTTP verb methods including `#get`, `#post`, `#put`, `#delete`, `#head`, `#patch`, and `#options`. Thus, the above example can be also written as:
+
+```ruby
+class DropletResource < ResourceKit::Resource
+  resources do
+    get :all, '/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
-connection = Faraday.new(url: 'http://api.digitalocean.com') do |req|
+conn = Faraday.new(url: 'http://api.digitalocean.com') do |req|
   req.adapter :net_http
 end
 
-resource = DropletResource.new(connection)
+resource = DropletResource.new(connection: conn)
 ```
 
 Now that we've instantiated a resource with our class, we can call the actions we've defined on it.
@@ -107,7 +120,7 @@ class CommentResource < ResourceKit::Resource
 end
 
 user = User.find(123)
-resource = CommentResource.new(connection, user)
+resource = CommentResource.new(connection: conn, scope: user)
 comments = resource.all #=> Will fetch from /users/123/comments
 ```
 

data/examples/digitalocean_droplets.rb

@@ -43,11 +43,11 @@ class DropletResource < ResourceKit::Resource
 end
 
 token = 'YOUR_ACCESS_TOKEN'
-connection = Faraday.new(url: 'https://api.digitalocean.com', headers: { content_type: 'application/json', authorization: "Bearer #{token}" }) do |req|
+conn = Faraday.new(url: 'https://api.digitalocean.com', headers: { content_type: 'application/json', authorization: "Bearer #{token}" }) do |req|
   req.adapter :net_http
 end
 
-resource = DropletResource.new(connection)
+resource = DropletResource.new(connection: conn)
 
 # Retrieve all droplets
-puts resource.all
+puts resource.all

data/examples/httpbin_client.rb

@@ -0,0 +1,15 @@
+require 'resource_kit'
+
+class HTTPBinResource < ResourceKit::Resource
+  resources do
+    get '/ip' => :ip
+    get '/status/:code' => :status
+  end
+end
+
+conn = Faraday.new(url: 'http://httpbin.org')
+resource = HTTPBinResource.new(connection: conn)
+
+puts resource.ip
+puts
+puts resource.status(code: 418)

data/lib/resource_kit.rb

@@ -1,5 +1,4 @@
-require "resource_kit/version"
-require 'active_support/core_ext'
+require 'resource_kit/version'
 require 'faraday'
 
 module ResourceKit

data/lib/resource_kit/action.rb

@@ -31,11 +31,13 @@ module ResourceKit
     end
 
     def handler(*response_codes, &block)
-      response_codes.each do |code|
-        unless code.is_a?(Fixnum)
-          code = StatusCodeMapper.code_for(code)
+      if response_codes.empty?
+        handlers[:any] = block
+      else
+        response_codes.each do |code|
+          code = StatusCodeMapper.code_for(code) unless code.is_a?(Fixnum)
+          handlers[code] = block
         end
-        handlers[code] = block
       end
     end
 
@@ -61,4 +63,4 @@ module ResourceKit
       nil
     end
   end
-end
+end

data/lib/resource_kit/action_invoker.rb

@@ -15,7 +15,7 @@ module ResourceKit
     end
 
     def handle_response
-      if handler = action.handlers[response.status]
+      if handler = action.handlers[response.status] || action.handlers[:any]
         resource.instance_exec(response, &handler)
       else
         response.body
@@ -29,10 +29,10 @@ module ResourceKit
     def response
       return @response if @response
 
-      raise ArgumentError, "Verb '#{action.verb}' is not allowed" unless action.verb.in?(ALLOWED_VERBS)
+      raise ArgumentError, "Verb '#{action.verb}' is not allowed" unless ALLOWED_VERBS.include?(action.verb)
 
       @response = connection.send(action.verb, resolver.resolve(options)) do |request|
-        request.body = construct_body if action.body and action.verb.in?([:post, :put, :patch])
+        request.body = construct_body if action.body and [:post, :put, :patch].include?(action.verb)
         append_hooks(:before, request)
       end
     end
@@ -55,4 +55,4 @@ module ResourceKit
       end
     end
   end
-end
+end

data/lib/resource_kit/endpoint_resolver.rb

@@ -27,16 +27,18 @@ module ResourceKit
     end
 
     def normalized_path_components(*components)
-      components.reject(&:blank?).map do |piece|
+      components.reject(&:empty?).map do |piece|
         # Remove leading and trailing forward slashes
         piece.gsub(/(^\/)|(\/$)/, '')
       end.join('/').insert(0, '/')
     end
 
     def append_query_values(uri, values)
-      query_param_keys.each_with_object({}) do |key, query_values|
+      params = query_param_keys.each_with_object({}) do |key, query_values|
         query_values[key] = values[key] if values.has_key?(key)
-      end.to_query
+      end
+
+      URI.encode_www_form(params)
     end
   end
-end
+end

data/lib/resource_kit/inheritable_attribute.rb

@@ -0,0 +1,20 @@
+module ResourceKit
+  module InheritableAttribute
+    def inheritable_attr(name)
+      instance_eval <<-RUBY
+        def #{name}=(v)
+          @#{name} = v
+        end
+
+        def #{name}
+          @#{name} ||= InheritableAttribute.inherit(self, :#{name})
+        end
+      RUBY
+    end
+
+    def self.inherit(klass, name)
+      return unless klass.superclass.respond_to?(name) and value = klass.superclass.send(name)
+      value.clone
+    end
+  end
+end

data/lib/resource_kit/resource.rb

@@ -1,6 +1,9 @@
+require 'resource_kit/inheritable_attribute'
+
 module ResourceKit
   class Resource
-    class_attribute :_resources
+    extend InheritableAttribute
+    inheritable_attr :_resources
 
     attr_reader :connection, :scope
 
@@ -27,5 +30,11 @@ module ResourceKit
     def action_and_connection(action_name)
       ActionConnection.new(action(action_name), connection)
     end
+
+    private
+
+    def _resources
+      self.class._resources
+    end
   end
-end
+end

data/lib/resource_kit/resource_collection.rb

@@ -14,12 +14,21 @@ module ResourceKit
       action.tap { |a| self << a }
     end
 
+    ResourceKit::ALLOWED_VERBS.each do |verb|
+      define_method verb do |path_name, &block|
+        path, name = path_name.to_a.flatten
+        action(name, "#{verb.upcase} #{path}", &block)
+      end
+    end
+
     def default_handler(*response_codes, &block)
-      response_codes.each do |code|
-        unless code.is_a?(Fixnum)
-          code = StatusCodeMapper.code_for(code)
+      if response_codes.empty?
+        default_handlers[:any] = block
+      else
+        response_codes.each do |code|
+          code = StatusCodeMapper.code_for(code) unless code.is_a?(Fixnum)
+          default_handlers[code] = block
         end
-        default_handlers[code] = block
       end
     end
 
@@ -43,4 +52,4 @@ module ResourceKit
       return matched[:verb], matched[:path]
     end
   end
-end
+end

data/lib/resource_kit/testing/action_handler_matchers.rb

@@ -1,3 +1,5 @@
+require 'ostruct'
+
 module ResourceKit
   module Testing
     class ActionHandlerMatchers
@@ -31,4 +33,4 @@ module ResourceKit
       end
     end
   end
-end
+end

data/lib/resource_kit/version.rb

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

data/resource_kit.gemspec

@@ -20,7 +20,6 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency 'faraday'
-  spec.add_dependency 'activesupport', '>= 3.0'
   spec.add_dependency 'addressable', '~> 2.3.6'
 
   spec.add_development_dependency "bundler", "~> 1.6"

data/spec/lib/resource_kit/action_invoker_spec.rb

@@ -60,6 +60,15 @@ RSpec.describe ResourceKit::ActionInvoker do
         result = ResourceKit::ActionInvoker.call(action, resource)
         expect(result).to eq('404ed')
       end
+
+      it 'uses a default handler if provided' do
+        action.verb :get
+        action.path '/users'
+        action.handler { |response| 'Something unexpected happened.' }
+
+        result = ResourceKit::ActionInvoker.call(action, resource)
+        expect(result).to eq('Something unexpected happened.')
+      end
     end
 
     context 'for requests with bodies' do
@@ -144,4 +153,4 @@ RSpec.describe ResourceKit::ActionInvoker do
       end
     end
   end
-end
+end

data/spec/lib/resource_kit/inheritable_attribute_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+
+describe ResourceKit::InheritableAttribute do
+  subject do
+    Class.new(Object) do
+      extend ResourceKit::InheritableAttribute
+
+      inheritable_attr :_resources
+    end
+  end
+
+  it 'provides a reader with an empty inherited attribute' do
+    expect(subject._resources).to be_nil
+  end
+
+  it 'provides a reader with empty inherited attributes in a derived class' do
+    expect(Class.new(subject)._resources).to be_nil
+
+    # subject._resouces = true
+    # Class.new(subject)._resources # TODO: crashes.
+  end
+
+  it 'provides an attribute copy in subclasses' do
+    subject._resources = []
+    expect(subject._resources.object_id).not_to eq Class.new(subject)._resources.object_id
+  end
+
+  it 'provides a writer' do
+    subject._resources = [:resource]
+    expect(subject._resources).to eq [:resource]
+  end
+
+  it 'inherits attributes' do
+    subject._resources = [:resource]
+
+    subclass_a = Class.new(subject)
+    subclass_a._resources << :another_resource
+
+    subclass_b = Class.new(subject)
+    subclass_b._resources << :different_resource
+
+    expect(subject._resources).to eq [:resource]
+    expect(subclass_a._resources).to eq [:resource, :another_resource]
+    expect(subclass_b._resources).to eq [:resource, :different_resource]
+  end
+
+  it 'does not inherit attributes if we set explicitely' do
+    subject._resources = [:resource]
+    subclass = Class.new(subject)
+
+    subclass._resources = [:another_resource]
+    expect(subclass._resources).to eq [:another_resource]
+  end
+end

data/spec/lib/resource_kit/resource_collection_spec.rb

@@ -11,6 +11,13 @@ RSpec.describe ResourceKit::ResourceCollection do
       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
@@ -32,12 +39,17 @@ RSpec.describe ResourceKit::ResourceCollection do
 
     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 { collection.default_handler(:ok, &handler) }
+      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
@@ -52,4 +64,4 @@ RSpec.describe ResourceKit::ResourceCollection do
       expect(retrieved_action.name).to eq(:all)
     end
   end
-end
+end

data/spec/lib/resource_kit/resource_spec.rb

@@ -24,6 +24,7 @@ RSpec.describe ResourceKit::Resource do
 
       it "defines the action method" do
         expect(droplet_resource).to respond_to(:find)
+        expect(droplet_resource).to respond_to(:all)
       end
     end
   end
@@ -62,4 +63,4 @@ RSpec.describe ResourceKit::Resource do
       expect(instance.action(:find)).to be_kind_of(ResourceKit::Action)
     end
   end
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: resource_kit
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Robert Ross
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-27 00:00:00.000000000 Z
+date: 2014-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -25,20 +25,6 @@ dependencies:
     - - ">="
       - !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
@@ -152,10 +138,12 @@ files:
 - README.md
 - Rakefile
 - examples/digitalocean_droplets.rb
+- examples/httpbin_client.rb
 - lib/resource_kit.rb
 - lib/resource_kit/action.rb
 - lib/resource_kit/action_invoker.rb
 - lib/resource_kit/endpoint_resolver.rb
+- lib/resource_kit/inheritable_attribute.rb
 - lib/resource_kit/method_factory.rb
 - lib/resource_kit/resource.rb
 - lib/resource_kit/resource_collection.rb
@@ -169,6 +157,7 @@ files:
 - spec/lib/resource_kit/action_invoker_spec.rb
 - spec/lib/resource_kit/action_spec.rb
 - spec/lib/resource_kit/endpoint_resolver_spec.rb
+- spec/lib/resource_kit/inheritable_attribute_spec.rb
 - spec/lib/resource_kit/method_factory_spec.rb
 - spec/lib/resource_kit/resource_collection_spec.rb
 - spec/lib/resource_kit/resource_spec.rb
@@ -206,6 +195,7 @@ test_files:
 - spec/lib/resource_kit/action_invoker_spec.rb
 - spec/lib/resource_kit/action_spec.rb
 - spec/lib/resource_kit/endpoint_resolver_spec.rb
+- spec/lib/resource_kit/inheritable_attribute_spec.rb
 - spec/lib/resource_kit/method_factory_spec.rb
 - spec/lib/resource_kit/resource_collection_spec.rb
 - spec/lib/resource_kit/resource_spec.rb