json_api_client 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b850c5b674039c387b45ecaa49c4800a667bf503
-  data.tar.gz: b0a12cdba47effcf2e5708a64852445dc77b494c
+  metadata.gz: 10641ff8a17866b4787a265a7f2067fd3ed68e0c
+  data.tar.gz: 87292de4965d7692869bded6f648a317083d4770
 SHA512:
-  metadata.gz: f4f52b341ab65f8993f90c347d0d114c91f1ab269d018190f3e937c38f08c19c725d1be84ef0751364c9b3655536556b05b5a928e19c251deb69c9a0cfa86e89
-  data.tar.gz: d5df64cc6493f06792596c879bad18f031398bc306a6c8fe179d97ff10d8ffc2ce1fc032875b39e4fd030e70265cd4791a0edbc2f1964182a5df783bdaae9a15
+  metadata.gz: 6730d8e95fe347c9a5687cd9891f3e74cd7fe1e243103a20c7d3ab3afa217312e2baaedae2bbe7a5958f96e2929e1795a07cc4dd8b10cbad10ab1bbe169c3921
+  data.tar.gz: 0fa330613ac5400f7a077ec870c91cb507c78dc017b628a432ff7cd5c62bca0b49b9ddc67f163f742f1f7c6fba83e1e225d5d866ae2066fdb8fe33bee1a02b87

data/README.md

@@ -113,6 +113,25 @@ module MyApi
   	belongs_to :user
   end
 end
+```
+
+## Custom Methods
 
+You can create custom methods on both collections (class method) and members (instance methods).
 
 ```
+module MyApi
+  class User < JsonApiClient::Resource
+  
+  	# GET /users/search.json
+  	custom_endpoint :search, on: :collection, request_method: :get
+  	
+  	# PUT /users/:id/verify.json
+  	custom_endpoint :verify, on: :member, request_method: :put
+  end
+end
+```
+
+In the above scenario, you can call the class method `MyApi::User.search`.  The results will be parsed like any other query.  If the response returns users, you will get back a `ResultSet` of `MyApi::User` instances.
+
+You can also call the instance method `verify` on a `MyApi::User` instance.

data/lib/json_api_client/helpers/custom_endpoints.rb

@@ -0,0 +1,39 @@
+module JsonApiClient
+  module Helpers
+    module CustomEndpoints
+      extend ActiveSupport::Concern
+
+      module ClassMethods
+        def custom_endpoint(name, options = {})
+          if :collection == options.delete(:on)
+            collection_endpoint(name, options)
+          else
+            member_endpoint(name, options)
+          end
+        end
+
+        def collection_endpoint(name, options = {})
+          self.class.send(:define_method, name) do |*params|
+            input = {
+              name: name,
+              params: request_params = params.first || {}
+            }.merge(options)
+            run_request(Query::Custom.new(self, input))
+          end
+        end
+
+        def member_endpoint(name, options = {})
+          define_method name do |*params|
+            request_params = params.first || {}
+            request_params[self.class.primary_key] = attributes.fetch(primary_key)
+            input = {
+              name: name, 
+              params: request_params
+            }.merge(options)
+            run_request(Query::Custom.new(self.class, input))
+          end
+        end
+      end
+    end
+  end
+end

data/lib/json_api_client/helpers.rb

@@ -2,6 +2,7 @@ module JsonApiClient
   module Helpers
     autoload :Associable, 'json_api_client/helpers/associable'
     autoload :Attributable, 'json_api_client/helpers/attributable'
+    autoload :CustomEndpoints, 'json_api_client/helpers/custom_endpoints'
     autoload :Initializable, 'json_api_client/helpers/initializable'
     autoload :Linkable, 'json_api_client/helpers/linkable'
     autoload :Parsable, 'json_api_client/helpers/parsable'

data/lib/json_api_client/query/custom.rb

@@ -0,0 +1,22 @@
+module JsonApiClient
+  module Query
+    class Custom < Base
+
+      def request_method
+        @request_method
+      end
+
+      def path
+        [@path, @options[:name]].join("/")
+      end
+
+      def build_params(params)
+        opts = params.dup
+        @request_method = opts.delete(:request_method) || :get
+        @params = opts.delete(:params) || {}
+        @options = opts
+      end
+
+    end
+  end
+end

data/lib/json_api_client/query.rb

@@ -2,6 +2,7 @@ module JsonApiClient
   module Query
     autoload :Base, 'json_api_client/query/base'
     autoload :Create, 'json_api_client/query/create'
+    autoload :Custom, 'json_api_client/query/custom'
     autoload :Destroy, 'json_api_client/query/destroy'
     autoload :Find, 'json_api_client/query/find'
     autoload :Update, 'json_api_client/query/update'

data/lib/json_api_client/resource.rb

@@ -51,6 +51,7 @@ module JsonApiClient
     include Helpers::Queryable
     include Helpers::Serializable
     include Helpers::Linkable
+    include Helpers::CustomEndpoints
 
     def save
       query = persisted? ? 

data/lib/json_api_client/version.rb

@@ -1,3 +1,3 @@
 module JsonApiClient
-  VERSION = "0.1.3"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: json_api_client
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Jeff Ching
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-15 00:00:00.000000000 Z
+date: 2014-04-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -86,6 +86,7 @@ files:
 - lib/json_api_client/helpers.rb
 - lib/json_api_client/helpers/associable.rb
 - lib/json_api_client/helpers/attributable.rb
+- lib/json_api_client/helpers/custom_endpoints.rb
 - lib/json_api_client/helpers/initializable.rb
 - lib/json_api_client/helpers/linkable.rb
 - lib/json_api_client/helpers/parsable.rb
@@ -98,6 +99,7 @@ files:
 - lib/json_api_client/query.rb
 - lib/json_api_client/query/base.rb
 - lib/json_api_client/query/create.rb
+- lib/json_api_client/query/custom.rb
 - lib/json_api_client/query/destroy.rb
 - lib/json_api_client/query/find.rb
 - lib/json_api_client/query/update.rb
@@ -131,3 +133,4 @@ signing_key:
 specification_version: 4
 summary: Build client libraries compliant with specification defined by jsonapi.org
 test_files: []
+has_rdoc: