json_api_client 1.0.0.beta2 → 1.0.0.beta3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 738f41ec73db3cf6cdf208abb4ad48ea7fc50e39
-  data.tar.gz: a0b6dfce9e509e9d7ac206ba742ce3b52e41a04e
+  metadata.gz: 1af573eac7e606a57e398c563b46b41ed2f4aea0
+  data.tar.gz: 0c6b27e6af8fd78b449a253226c1a37e9c83c81b
 SHA512:
-  metadata.gz: d20ef7885deb0589bbb6d6d7fa89d40ef7dbf192e1461ba006f4124c0986a581ce0da11d1bf5d9ce308610ef142effcc11ceb7aa4a91f78752db9f511357837e
-  data.tar.gz: 2dd89bd5ea1b889f71a1b62826f087ebb30078a38f20218483fdf119928a3e0f724db2f10fb2dfcef58dba7ab3f48b108d7c9ade2133f469aed8dbf4c47dbaaf
+  metadata.gz: 5cefa69d519d148e9298e36a0bba1e11605a59b841e34d9eb5c213ed7e56eecfe6e6a86914584b84777e513d707c6b4cebd597b701406cdfc9d33a89454e19e3
+  data.tar.gz: 7ee4e4c5e432f24f232349ce0ee4565fdec370c00de50b5ba1f27291dee3bc9aa9095608a9ad48e6ea0b35b971128248dbfa94dd3b5bc9526f0a386092d9163d

data/README.md

@@ -2,7 +2,7 @@
 
 This gem is meant to help you build an API client for interacting with REST APIs as laid out by [http://jsonapi.org](http://jsonapi.org). It attempts to give you a query building framework that is easy to understand (it is similar to ActiveRecord scopes).
 
-*Note: master is currently tracking the 1.0.0 RC3 specification. If you're looking for the older code, see [0.x branch](https://github.com/chingor13/json_api_client/tree/0.x)*
+*Note: master is currently tracking the 1.0.0 specification. If you're looking for the older code, see [0.x branch](https://github.com/chingor13/json_api_client/tree/0.x)*
 
 *Note: This is still a work in progress.*
 
@@ -31,7 +31,7 @@ end
 
 By convention, we figure guess the resource route from the class name. In the above example, `Article`'s path is "http://example.com/articles" and `Person`'s path would be "http://example.com/people".
 
-Some example usage:
+Some basic example usage:
 
 ```
 MyApi::Article.all
@@ -60,6 +60,8 @@ All class level finders/creators should return a `JsonApiClient::ResultSet` whic
 
 ## Handling Validation Errors
 
+[See specification](http://jsonapi.org/format/#errors)
+
 Out of the box, `json_api_client` handles server side validation only.
 
 ```
@@ -69,9 +71,19 @@ User.create(name: "Bob", email_address: "invalid email")
 user = User.new(name: "Bob", email_address: "invalid email")
 user.save
 => false
+
+# returns an error collector which is array-like
 user.errors
 => ["Email address is invalid"]
 
+# get all error titles
+user.errors.full_messages
+=> ["Email address is invalid"]
+
+# get errors for a specific parameter
+user.errors[:email_address]
+=> ["Email address is invalid"]
+
 user = User.find(1)
 user.update_attributes(email_address: "invalid email")
 => false
@@ -81,6 +93,8 @@ user.email_address
 => "invalid email"
 ```
 
+For now we are assuming that error sources are all parameters.
+
 If you want to add client side validation, I suggest creating a form model class that uses ActiveModel's validations.
 
 ## Meta information
@@ -204,10 +218,10 @@ article.created_at
 [See specification](http://jsonapi.org/format/#fetching-sorting)
 
 ```
-# makes request to /people?sort=+age
+# makes request to /people?sort=age
 youngest = Person.sort(:age).all
 
-# also makes request to /people?sort=+age
+# also makes request to /people?sort=age
 youngest = Person.sort(age: :asc).all
 
 # makes request to /people?sort=-age
@@ -228,7 +242,7 @@ articles = Article.page(2).per(30).to_a
 articles = Article.paginate(page: 2, per_page: 30).to_a
 ```
 
-*Note: The mapping of pagination parameters is done by the `query_builder` which is [customizable](#fixme).*
+*Note: The mapping of pagination parameters is done by the `query_builder` which is [customizable](#custom-paginator).*
 
 ### Browsing
 
@@ -299,6 +313,23 @@ Also, we consider `nil` to be an acceptable value and will not cast the value.
 
 ## Customizing
 
+### Paths
+
+You can customize this path by changing your resource's `table_name`:
+
+```
+module MyApi
+  class SomeResource < Base
+    def self.table_name
+      "foobar"
+    end
+  end
+end
+
+# requests http://example.com/foobar
+MyApi::SomeResource.all
+```
+
 ### Connections
 
 You can configure your API client to use a custom connection that implementes the `run` instance method. It should return data that your parser can handle. The default connection class wraps Faraday and lets you add middleware.

data/lib/json_api_client/helpers/queryable.rb

@@ -6,7 +6,7 @@ module JsonApiClient
       included do
         class << self
           extend Forwardable
-          def_delegators :new_scope, :where, :order, :includes, :select, :all, :paginate, :page, :first
+          def_delegators :new_scope, :where, :order, :includes, :select, :all, :paginate, :page, :first, :find
         end
         class_attribute :connection_class, :connection_object, :connection_options, :query_builder
         self.connection_class = Connection

data/lib/json_api_client/helpers/requestable.rb

@@ -10,10 +10,6 @@ module JsonApiClient
       end
 
       module ClassMethods
-        def find(conditions)
-          requestor.find(conditions)
-        end
-
         def create(conditions = {})
           new(conditions).tap do |resource|
             resource.save

data/lib/json_api_client/query/builder.rb

@@ -6,6 +6,7 @@ module JsonApiClient
 
       def initialize(klass)
         @klass = klass
+        @primary_key = nil
         @pagination_params = {}
         @filters = {}
         @includes = []
@@ -64,19 +65,39 @@ module JsonApiClient
           .merge(includes_params)
           .merge(order_params)
           .merge(select_params)
+          .merge(primary_key_params)
       end
 
       def to_a
-        @to_a ||= klass.find(params)
+        @to_a ||= find
       end
       alias all to_a
 
+      def find(args = {})
+        case args
+        when Hash
+          where(args)
+        else
+          @primary_key = args
+        end
+
+        klass.requestor.get(params)
+      end
+
       def method_missing(method_name, *args, &block)
         to_a.send(method_name, *args, &block)
       end
 
       private
 
+      def primary_key_params
+        return {} unless @primary_key
+
+        @primary_key.is_a?(Array) ?
+          {klass.primary_key.to_s.pluralize.to_sym => @primary_key.join(",")} :
+          {klass.primary_key => @primary_key}
+      end
+
       def pagination_params
         @pagination_params.empty? ? {} : {page: @pagination_params}
       end
@@ -121,11 +142,11 @@ module JsonApiClient
           case arg
           when Hash
             arg.map do |k, v|
-              operator = (v == :desc ? "-" : "+")
+              operator = (v == :desc ? "-" : "")
               "#{operator}#{k}"
             end
           else
-            "+#{arg}"
+            "#{arg}"
           end
         end.flatten
       end

data/lib/json_api_client/query/requestor.rb

@@ -20,16 +20,7 @@ module JsonApiClient
         })
       end
 
-      def find(args)
-        params = case args
-        when Hash
-          args
-        when Array
-          {klass.primary_key.to_s.pluralize.to_sym => args.join(",")}
-        else
-          {klass.primary_key => args}
-        end
-
+      def get(params = {})
         path = resource_path(params)
         params.delete(klass.primary_key)
         request(:get, path, params)

data/lib/json_api_client/version.rb

@@ -1,3 +1,3 @@
 module JsonApiClient
-  VERSION = "1.0.0.beta2"
+  VERSION = "1.0.0.beta3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: json_api_client
 version: !ruby/object:Gem::Version
-  version: 1.0.0.beta2
+  version: 1.0.0.beta3
 platform: ruby
 authors:
 - Jeff Ching
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-02 00:00:00.000000000 Z
+date: 2015-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport