json_api_client 1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 97343e5f4ab100e19f26bc047874835f90d8e76a
-  data.tar.gz: 6009f0ddb1f43af631e3b10a6e0bd9bd5cf7c9c7
+  metadata.gz: 48365ff770cd7617bd8d4ca4bdc47815b1f16096
+  data.tar.gz: 1691aa8373f863f00f9cf8020c810424aebd0fb2
 SHA512:
-  metadata.gz: f35608521648cf8337507f466831598a4bb77e5254f60c18a0bbeeac854c8832eeb5b7d8faf63b356e953d1bb4f11958339c98e9d453e69dab21d50c3b0e211d
-  data.tar.gz: e3a07f87d572b36eab928742f87688d38dc02bbb2f65e62ee8e30f71fc125a6c1c5715f32e17e62a6d0a5bc63ab7f4386d76ccbecdfb9ed6719ae5b670accc72
+  metadata.gz: 72606bea939fb0c0770fd85120dcd7fa09762b44abcb8fcb53f95c2f0e60420b7c3acebfc55e3fec6e586585f7dad97df62a5bc6fab50961205f35085a7461c0
+  data.tar.gz: f08837628c8717af1b6040f296d6609843b708d274da8d2197464445278eca13066f28d30a5e68da880b69080444f7b3f4be59b98dbf1f13ffb8a6f9081a9014

data/README.md

@@ -27,7 +27,7 @@ module MyApi
 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".
+By convention, we 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 basic example usage:
 
@@ -204,7 +204,7 @@ authors = results.map(&:author)
 
 ```ruby
 # makes request to /articles?fields[articles]=title,body
-article = Article.select("title,body").first
+article = Article.select("title", "body").first
 
 # should have fetched the requested fields
 article.title

data/lib/json_api_client/errors.rb

@@ -25,6 +25,12 @@ module JsonApiClient
       end
     end
 
+    class Conflict < ServerError
+      def message
+        "Resource already exists"
+      end
+    end
+
     class NotFound < ServerError
       attr_reader :uri
       def initialize(uri)
@@ -47,4 +53,4 @@ module JsonApiClient
     end
 
   end
-end
+end

data/lib/json_api_client/formatter.rb

@@ -0,0 +1,145 @@
+# Taken form jsonapi_resources formatter
+
+require 'active_support/inflector'
+
+module JsonApiClient
+  class Formatter
+    class << self
+      def format(arg)
+        arg.to_s
+      end
+
+      def unformat(arg)
+         # We call to_s() here so that unformat consistently returns a string
+         # (instead of a symbol) regardless which Formatter subclass it is called on
+        arg.to_s
+      end
+
+      def formatter_for(format)
+        formatter_class_name = "JsonApiClient::#{format.to_s.camelize}Formatter"
+        formatter_class_name.safe_constantize
+      end
+    end
+  end
+
+  class KeyFormatter < Formatter
+    class << self
+      def format(key)
+        super
+      end
+
+      def format_keys(hash)
+        Hash[
+          hash.map do |key, value|
+            [format(key).to_sym, value]
+          end
+        ]
+      end
+
+      def unformat(formatted_key)
+        super
+      end
+    end
+  end
+
+  class RouteFormatter < Formatter
+    class << self
+      def format(route)
+        super
+      end
+
+      def unformat(formatted_route)
+        super
+      end
+    end
+  end
+
+  class ValueFormatter < Formatter
+    class << self
+      def format(raw_value)
+        super(raw_value)
+      end
+
+      def unformat(value)
+        super(value)
+      end
+
+      def value_formatter_for(type)
+        formatter_name = "#{type.to_s.camelize}Value"
+        formatter_for(formatter_name)
+      end
+    end
+  end
+
+  class UnderscoredKeyFormatter < KeyFormatter
+  end
+
+  class CamelizedKeyFormatter < KeyFormatter
+    class << self
+      def format(key)
+        super.camelize(:lower)
+      end
+
+      def unformat(formatted_key)
+        formatted_key.to_s.underscore
+      end
+    end
+  end
+
+  class DasherizedKeyFormatter < KeyFormatter
+    class << self
+      def format(key)
+        super.dasherize
+      end
+
+      def unformat(formatted_key)
+        formatted_key.to_s.underscore
+      end
+    end
+  end
+
+  class DefaultValueFormatter < ValueFormatter
+    class << self
+      def format(raw_value)
+        raw_value
+      end
+    end
+  end
+
+  class IdValueFormatter < ValueFormatter
+    class << self
+      def format(raw_value)
+        return if raw_value.nil?
+        raw_value.to_s
+      end
+    end
+  end
+
+  class UnderscoredRouteFormatter < RouteFormatter
+  end
+
+  class CamelizedRouteFormatter < RouteFormatter
+    class << self
+      def format(route)
+        super.camelize(:lower)
+      end
+
+      def unformat(formatted_route)
+        formatted_route.to_s.underscore
+      end
+    end
+  end
+
+  class DasherizedRouteFormatter < RouteFormatter
+    class << self
+      def format(route)
+        super.dasherize
+      end
+
+      def unformat(formatted_route)
+        formatted_route.to_s.underscore
+      end
+    end
+  end
+
+end

data/lib/json_api_client/helpers/dynamic_attributes.rb

@@ -38,7 +38,13 @@ module JsonApiClient
       protected
 
       def method_missing(method, *args, &block)
-        if method.to_s =~ /^(.*)=$/
+        normalized_method = if key_formatter
+                              key_formatter.unformat(method.to_s)
+                            else
+                              method.to_s
+                            end
+
+        if normalized_method =~ /^(.*)=$/
           set_attribute($1, args.first)
         elsif has_attribute?(method)
           attributes[method]
@@ -55,6 +61,10 @@ module JsonApiClient
         attributes[name] = value
       end
 
+      def key_formatter
+        self.class.respond_to?(:key_formatter) && self.class.key_formatter
+      end
+
     end
   end
 end

data/lib/json_api_client/included_data.rb

@@ -6,7 +6,7 @@ module JsonApiClient
       record_class = result_set.record_class
       grouped_data = data.group_by{|datum| datum["type"]}
       @data = grouped_data.inject({}) do |h, (type, records)|
-        klass = Utils.compute_type(record_class, type.singularize.classify)
+        klass = Utils.compute_type(record_class, record_class.key_formatter.unformat(type).singularize.classify)
         h[type] = records.map do |datum|
           params = klass.parser.parameters_from_resource(datum)
           resource = klass.load(params)

data/lib/json_api_client/meta_data.rb

@@ -2,9 +2,18 @@ module JsonApiClient
   class MetaData
     include Helpers::DynamicAttributes
 
-    def initialize(data)
+    attr_accessor :record_class
+
+    def initialize(data, record_class = nil)
+      self.record_class = record_class
       self.attributes = data
     end
 
+    protected
+
+    def key_formatter
+      record_class && record_class.key_formatter
+    end
+
   end
-end
+end

data/lib/json_api_client/middleware/status.rb

@@ -26,6 +26,8 @@ module JsonApiClient
           raise Errors::AccessDenied, env
         when 404
           raise Errors::NotFound, env[:url]
+        when 409
+          raise Errors::Conflict, env
         when 400..499
           # some other error
         when 500..599
@@ -36,4 +38,4 @@ module JsonApiClient
       end
     end
   end
-end
+end

data/lib/json_api_client/paginating/paginator.rb

@@ -40,7 +40,7 @@ module JsonApiClient
       def total_entries
         per_page * total_pages
       end
-      alias_method :total_count, :total_entries
+      def total_count; total_entries; end
 
       def offset
         per_page * (current_page - 1)

data/lib/json_api_client/parsers/parser.rb

@@ -65,7 +65,7 @@ module JsonApiClient
 
           # we will treat everything as an Array
           results = [results] unless results.is_a?(Array)
-          resources = results.map do |res|
+          resources = results.compact.map do |res|
             resource = result_set.record_class.load(parameters_from_resource(res))
             resource.last_result_set = result_set
             resource
@@ -78,7 +78,7 @@ module JsonApiClient
         end
 
         def handle_meta(result_set, data)
-          result_set.meta = MetaData.new(data.fetch("meta", {}))
+          result_set.meta = MetaData.new(data.fetch("meta", {}), result_set.record_class)
         end
 
         def handle_links(result_set, data)

data/lib/json_api_client/query/builder.rb

@@ -3,6 +3,7 @@ module JsonApiClient
     class Builder
 
       attr_reader :klass, :path_params
+      delegate :key_formatter, to: :klass
 
       def initialize(klass)
         @klass = klass
@@ -33,8 +34,12 @@ module JsonApiClient
         self
       end
 
-      def select(fields)
-        @fields += fields.split(",").map(&:strip)
+      def select(*fields)
+        fields = Array(fields).flatten
+        fields = fields.map { |i| i.to_s.split(",") }.flatten
+
+        @fields += fields.map(&:strip)
+
         self
       end
 
@@ -151,7 +156,7 @@ module JsonApiClient
               parse_related_links(*v)
             end
           else
-            table
+            key_formatter.format(table)
           end
         end.flatten
       end

data/lib/json_api_client/resource.rb

@@ -29,6 +29,8 @@ module JsonApiClient
                     :read_only_attributes,
                     :requestor_class,
                     :associations,
+                    :json_key_format,
+                    :route_format,
                     instance_accessor: false
     self.primary_key          = :id
     self.parser               = Parsers::Parser
@@ -42,6 +44,12 @@ module JsonApiClient
     self.requestor_class      = Query::Requestor
     self.associations         = []
 
+    #:underscored_key, :camelized_key, :dasherized_key, or custom
+    self.json_key_format = :underscored_key
+
+    #:underscored_route, :camelized_route, :dasherized_route, or custom
+    self.route_format = :underscored_route
+
     include Associations::BelongsTo
     include Associations::HasMany
     include Associations::HasOne
@@ -54,7 +62,7 @@ module JsonApiClient
       #
       # @return [String] The table name for this resource
       def table_name
-        resource_name.pluralize
+        route_formatter.format(resource_name.pluralize)
       end
 
       # The name of a single resource. i.e. Article -> article, Person -> person
@@ -64,6 +72,22 @@ module JsonApiClient
         name.demodulize.underscore
       end
 
+      # Specifies the JSON API resource type. By default this is inferred
+      # from the resource class name.
+      #
+      # @return [String] Resource path
+      def type
+        table_name
+      end
+
+      # Specifies the relative path that should be used for this resource;
+      # by default, this is inferred from the resource class name.
+      #
+      # @return [String] Resource path
+      def resource_path
+        table_name
+      end
+
       # Load a resource object from attributes and consider it persisted
       #
       # @return [Resource] Persisted resource object
@@ -92,14 +116,14 @@ module JsonApiClient
 
       # Return the path or path pattern for this resource
       def path(params = nil)
-        parts = [table_name]
-        if params
+        parts = [resource_path]
+        if params && _prefix_path.present?
           path_params = params.delete(:path) || params
           parts.unshift(_prefix_path % path_params.symbolize_keys)
         else
           parts.unshift(_prefix_path)
         end
-        parts.reject!{|part| part == "" }
+        parts.reject!(&:blank?)
         File.join(*parts)
       rescue KeyError
         raise ArgumentError, "Not all prefix parameters specified"
@@ -147,7 +171,7 @@ module JsonApiClient
       #
       # @return [Hash] Default attributes
       def default_attributes
-        {type: table_name}
+        {type: type}
       end
 
       # Returns the schema for this resource class
@@ -157,6 +181,14 @@ module JsonApiClient
         @schema ||= Schema.new
       end
 
+      def key_formatter
+        JsonApiClient::Formatter.formatter_for(json_key_format)
+      end
+
+      def route_formatter
+        JsonApiClient::Formatter.formatter_for(route_format)
+      end
+
       protected
 
       # Declares a new class/instance method that acts on the collection/member
@@ -258,6 +290,7 @@ module JsonApiClient
     #
     # @param params [Hash] Attributes, links, and relationships
     def initialize(params = {})
+      @persisted = nil
       self.links = self.class.linker.new(params.delete("links") || {})
       self.relationships = self.class.relationship_linker.new(params.delete("relationships") || {})
       self.class.associations.each do |association|
@@ -321,9 +354,9 @@ module JsonApiClient
     def as_json_api(*)
       attributes.slice(:id, :type).tap do |h|
         relationships_for_serialization.tap do |r|
-          h[:relationships] = r unless r.empty?
+          h[:relationships] = self.class.key_formatter.format_keys(r) unless r.empty?
         end
-        h[:attributes] = attributes_for_serialization
+        h[:attributes] = self.class.key_formatter.format_keys(attributes_for_serialization)
       end
     end
 
@@ -444,7 +477,9 @@ module JsonApiClient
     end
 
     def association_for(name)
-      self.class.associations.detect{|association| association.attr_name == name}
+      self.class.associations.detect do |association|
+        association.attr_name.to_s == self.class.key_formatter.unformat(name)
+      end
     end
 
     def attributes_for_serialization

data/lib/json_api_client/version.rb

@@ -1,3 +1,3 @@
 module JsonApiClient
-  VERSION = "1.1.1"
+  VERSION = "1.2.0"
 end

data/lib/json_api_client.rb

@@ -1,7 +1,7 @@
 require 'faraday'
 require 'faraday_middleware'
 require 'json'
-require "addressable/uri"
+require 'addressable/uri'
 
 module JsonApiClient
   autoload :Associations, 'json_api_client/associations'
@@ -9,6 +9,7 @@ module JsonApiClient
   autoload :Connection, 'json_api_client/connection'
   autoload :Errors, 'json_api_client/errors'
   autoload :ErrorCollector, 'json_api_client/error_collector'
+  autoload :Formatter, 'json_api_client/formatter'
   autoload :Helpers, 'json_api_client/helpers'
   autoload :Implementation, 'json_api_client/implementation'
   autoload :IncludedData, 'json_api_client/included_data'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: json_api_client
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Jeff Ching
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-25 00:00:00.000000000 Z
+date: 2016-07-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -126,6 +126,7 @@ files:
 - lib/json_api_client/connection.rb
 - lib/json_api_client/error_collector.rb
 - lib/json_api_client/errors.rb
+- lib/json_api_client/formatter.rb
 - lib/json_api_client/helpers.rb
 - lib/json_api_client/helpers/callbacks.rb
 - lib/json_api_client/helpers/dirty.rb
@@ -175,9 +176,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Build client libraries compliant with specification defined by jsonapi.org
 test_files: []
-has_rdoc: