resource_kit 0.0.3 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8bc66e1b067e94ec5db09d088e37cce2fb5a82f8
-  data.tar.gz: bb016cd88ad60b8d4e4579097baeeec5cd2aab27
+  metadata.gz: ee001caaa4f22885773d1f6e6ae076ec900762e2
+  data.tar.gz: b373c40127c0a4d7312ecea86ae634acd1ccbe85
 SHA512:
-  metadata.gz: 5e2d1b07c54d0a11b6af5a1449965451d7496de420b97084c46e9c96967042364ac3534e4668e2665da284d904900012d4add6a1307e4a8c0588860f3b85883d
-  data.tar.gz: f3ec8aeee8be01c5aaa3341abddce355c5267a8d1f2e1bbad79dadc8a2cb102b45dcb4e4cb7a206b2b8cd3de60f12fcb46105078f1060b6cdeb7de7cc50072d6
+  metadata.gz: dfcc677710aef8a376ac1d47e795b1267f2131ddd969f70352421b5b80788e7099a73dc04cba6282f5fe828ddc2f52ccc19e7856f0fbe591c8463381f4f89eb4
+  data.tar.gz: 987624fc56bb90b02ae917c91b8802fcc54697497b1776695fecd915d8b4e3f38dc73a98318bed5cebcc73b08c5c824c8a24f21e993324c8a2757277e0e17534

data/README.md

@@ -90,13 +90,12 @@ create = resource.create(Droplet.new)
 
 Things we've thought about but just haven't implemented are:
 
-* `action :find, 'PUT droplets/:id/restart'`
 * Pagination capabilities
 
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/resource_kit/fork )
+1. Fork it ( https://github.com/digitaloceancloud/resource_kit/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/lib/resource_kit.rb

@@ -4,6 +4,7 @@ require 'faraday'
 
 module ResourceKit
   ALLOWED_VERBS = [:get, :post, :put, :delete, :head, :patch, :options]
+  ActionConnection = Struct.new(:action, :connection)
 
   autoload :Resource, 'resource_kit/resource'
   autoload :ResourceCollection, 'resource_kit/resource_collection'

data/lib/resource_kit/action.rb

@@ -6,6 +6,7 @@ module ResourceKit
       @name = name
       @verb = (verb && verb.downcase.to_sym) || :get
       @path = path
+      @query_keys = []
     end
 
     def verb(v = nil)
@@ -18,6 +19,11 @@ module ResourceKit
       @path
     end
 
+    def query_keys(*keys)
+      return @query_keys if keys.empty?
+      @query_keys += keys
+    end
+
     def handlers
       @handlers ||= {}
     end

data/lib/resource_kit/action_invoker.rb

@@ -1,23 +1,19 @@
 module ResourceKit
   class ActionInvoker
-    def self.call(action, connection, *args)
-      raise ArgumentError, "Verb '#{action.verb}' is not allowed" unless action.verb.in?(ALLOWED_VERBS)
-      options = args.last.kind_of?(Hash) ? args.last : {}
-      resolver = EndpointResolver.new(path: action.path)
+    attr_reader :action, :connection, :args, :options
 
-      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, action)
-        end
-      else
-        response = connection.send(action.verb, resolver.resolve(options))
-      end
+    def initialize(action, connection, *args)
+      @action = action
+      @connection = connection
+      @args = args
+      @options = args.last.kind_of?(Hash) ? args.last : {}
+    end
 
-      handle_response(response, action)
+    def self.call(action, connection, *args)
+      new(action, connection, *args).handle_response
     end
 
-    def self.handle_response(response, action)
+    def handle_response
       if handler = action.handlers[response.status]
         handler.call(response)
       else
@@ -25,8 +21,27 @@ module ResourceKit
       end
     end
 
-    def self.construct_body(*args, action)
+    def construct_body
       action.body.call(*args[0..(action.body.arity - 1)])
     end
+
+    def response
+      return @response if @response
+
+      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))
+      end
+    end
+
+    def resolver
+      EndpointResolver.new(path: action.path, query_param_keys: action.query_keys)
+    end
   end
 end

data/lib/resource_kit/endpoint_resolver.rb

@@ -6,7 +6,7 @@ module ResourceKit
 
     def initialize(options = {})
       @path = options[:path]
-      @query_param_keys = options[:query_param_keys] || {}
+      @query_param_keys = options[:query_param_keys] || []
     end
 
     def resolve(values = {})

data/lib/resource_kit/resource.rb

@@ -1,6 +1,6 @@
 module ResourceKit
   class Resource
-    class_attribute :namespace
+    class_attribute :_resources
 
     attr_reader :connection
 
@@ -9,11 +9,19 @@ module ResourceKit
     end
 
     def self.resources(&block)
-      @resources ||= ResourceCollection.new
-      @resources.instance_eval(&block) if block_given?
+      self._resources ||= ResourceCollection.new
+      self._resources.instance_eval(&block) if block_given?
 
-      MethodFactory.construct(self, @resources)
-      @resources
+      MethodFactory.construct(self, self._resources)
+      self._resources
+    end
+
+    def action(name)
+      _resources.find_action(name)
+    end
+
+    def action_and_connection(action_name)
+      ActionConnection.new(action(action_name), connection)
     end
   end
 end

data/lib/resource_kit/version.rb

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

data/spec/lib/resource_kit/action_invoker_spec.rb

@@ -8,6 +8,7 @@ RSpec.describe ResourceKit::ActionInvoker do
       stub.get('/users/bad_page') { |env| [404, {}, 'not found'] }
       stub.get('/users/12') { |env| [200, {}, 'user 12'] }
       stub.post('/users') { |env| [200, {}, env[:body]] }
+      stub.get('/paged') { |env| [200, {}, env[:url].to_s] }
     end
   end
   let(:action) { ResourceKit::Action.new(:find) }
@@ -70,5 +71,17 @@ RSpec.describe ResourceKit::ActionInvoker do
         expect(result).to eq('echo me another')
       end
     end
+
+    context 'for requests with query params' do
+      it 'appends the query parameters to the endpoint' do
+        action.query_keys :per_page, :page
+        action.path '/paged'
+
+        result = ResourceKit::ActionInvoker.call(action, connection, page: 3, per_page: 300)
+        addressed = Addressable::URI.parse(result)
+
+        expect(addressed.query_values).to include('per_page' => '300', 'page' => '3')
+      end
+    end
   end
 end

data/spec/lib/resource_kit/action_spec.rb

@@ -52,4 +52,11 @@ RSpec.describe ResourceKit::Action do
       expect(action.body).to be(handler)
     end
   end
+
+  describe '#query_keys' do
+    it 'allows setting known query parameters that we should append to the URL' do
+      action.query_keys :per_page, :page
+      expect(action.query_keys).to include(:per_page, :page)
+    end
+  end
 end

data/spec/lib/resource_kit/resource_spec.rb

@@ -36,4 +36,20 @@ RSpec.describe ResourceKit::Resource do
       expect(instance.connection).to be(faraday)
     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(faraday)
+
+      expect(instance.action(:find)).to be_kind_of(ResourceKit::Action)
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: resource_kit
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.5
 platform: ruby
 authors:
 - Robert Ross
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-04 00:00:00.000000000 Z
+date: 2014-08-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday