json_api_client 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a6ba83068b0d92b968d8ab4edd3f4d4daca21f90
-  data.tar.gz: 53051631d82e0bddf15c2854d14382893a0448cd
+  metadata.gz: eafc20bde2b50f635c58ba67bd72c3234d3cf098
+  data.tar.gz: db4d71324f20cd39c03677afb1d089001ceac8cb
 SHA512:
-  metadata.gz: 3fab60fb4108bd15e9c7164370623c616153d52d5ca6c77df8b70a94ca0340a8a25b3dd8c18fbd73eb487616abf7857438950980a86b80261bda88e9cec0f918
-  data.tar.gz: 8d1998191c06f27e45208832a934b408214673a1a54c9318c875af1ccb9a0e293c1b159d6c83b5ebafbdba4a44ee55a348ea377fe88952cba6b256475ca0671a
+  metadata.gz: 0496018b36ad43f465f18f96b80d7361223cc70b0e3a0d956030ed19b756b9e72be62b7f85b7c98f7faea442d35f37ccf24664134d0b8338c50e016d1330cddf
+  data.tar.gz: ba8475927ba6c4f2af4b96aa84c5a4674e40b2c3a03255e471205d435a74b3dc0929f39d71d4573aee1821650a7cfd6faaea86c7c04dd473bf7f4a6740b3c948

data/README.md

@@ -159,4 +159,47 @@ You can also call the instance method `verify` on a `MyApi::User` instance.
 
 We also respect the [links specification](http://jsonapi.org/format/#document-structure-resource-relationships). The client can fetch linked resources based on the defined endpoint from the link specification as well as load data from any `linked` data provided in the response. Additionally, it will still fetch missing data if not all linked resources are provided in the `linked` data response.
 
-See the [tests](https://github.com/chingor13/json_api_client/blob/master/test/unit/links_test.rb).
+See the [tests](https://github.com/chingor13/json_api_client/blob/master/test/unit/links_test.rb).
+
+## Schema
+
+You can define schema within your client model. You can define basic types and set default values if you wish. If you declare a basic type, we will try to cast any input to be that type. 
+
+The added benefit of declaring your schema is that you can access fields before data is set (otherwise, you'll get a `NoMethodError`).
+
+### Example
+
+```
+class User < JsonApiClient::Resource
+  property :name, type: :string
+  property :is_admin, type: :boolean, default: false
+  property :points_accrued, type: :int, default: 0
+  property :averge_points_per_day, type: :float
+end
+
+# default values
+u = User.new
+u.name
+=> nil
+u.is_admin
+=> false
+u.points_accrued
+=> 0
+
+# casting
+u.average_points_per_day = "0.3"
+u.average_points_per_day
+=> 0.3
+
+```
+
+### Types
+
+The basic types that we allow are:
+
+* `:int` or `:integer`
+* `:float`
+* `:string`
+* `:boolean` - *Note: we will cast the string version of "true" and "false" to their respective values*
+
+Also, we consider `nil` to be an acceptable value and will not cast the value.

data/lib/json_api_client/helpers/attributable.rb

@@ -15,7 +15,9 @@ module JsonApiClient
         @attributes ||= {}.with_indifferent_access
 
         return @attributes unless attrs.present?
-        @attributes.merge!(attrs)
+        attrs.each do |key, value|
+          set_attribute(key, value)
+        end
       end
 
       def update_attributes(attrs = {})

data/lib/json_api_client/helpers/schemable.rb

@@ -0,0 +1,68 @@
+module JsonApiClient
+  module Helpers
+    module Schemable
+      extend ActiveSupport::Concern
+
+      included do
+        initializer do |obj, params|
+          obj.send(:set_default_values)
+        end
+      end
+
+      module ClassMethods
+        # Returns the schema for this resource class
+        #
+        # @return [Schema] the schema for this resource class
+        def schema
+          @schema ||= Schema.new
+        end
+
+        # Declares a new property by name
+        #
+        # @param name [Symbol] the name of the property
+        # @param options [Hash] property options
+        # @option options [Symbol] :type The property type
+        # @option options [Symbol] :default The default value for the property
+        def property(name, options = {})
+          schema.add(name, options)
+        end
+
+        # Declare multiple properties with the same optional options
+        #
+        # @param [Array<Symbol>] names
+        # @param options [Hash] property options
+        # @option options [Symbol] :type The property type
+        # @option options [Symbol] :default The default value for the property
+        def properties(*names)
+          options = names.last.is_a?(Hash) ? names.pop : {}
+          names.each do |name|
+            property name, options
+          end
+        end
+      end
+
+      protected
+
+      def set_attribute(name, value)
+        property = property_for(name)
+        value = property.cast(value) if property
+        super(name, value)
+      end
+
+      def has_attribute?(attr_name)
+        !!property_for(attr_name) || super
+      end
+
+      def set_default_values
+        self.class.schema.each_property do |property|
+          attributes[property.name] = property.default unless attributes.has_key?(property.name)
+        end
+      end
+
+      def property_for(name)
+        self.class.schema.find(name)
+      end
+
+    end
+  end
+end

data/lib/json_api_client/helpers.rb

@@ -7,6 +7,7 @@ module JsonApiClient
     autoload :Linkable, 'json_api_client/helpers/linkable'
     autoload :Parsable, 'json_api_client/helpers/parsable'
     autoload :Queryable, 'json_api_client/helpers/queryable'
+    autoload :Schemable, 'json_api_client/helpers/schemable'
     autoload :Serializable, 'json_api_client/helpers/serializable'
   end
 end

data/lib/json_api_client/resource.rb

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

data/lib/json_api_client/schema.rb

@@ -0,0 +1,64 @@
+module JsonApiClient
+  class Schema
+    Property = Struct.new(:name, :type, :default) do
+      def cast(value)
+        return nil if value.nil?
+        return value if type.nil?
+
+        case type.to_sym
+        when :int, :integer
+          value.to_i
+        when :string
+          value.to_s
+        when :float
+          value.to_f
+        when :boolean
+          if value.is_a?(String)
+            value == "false" ? false : true
+          else
+            !!value
+          end
+        else
+          value
+        end
+      end
+    end
+
+    def initialize
+      @properties = {}
+    end
+
+    # Add a property to the schema
+    #
+    # @param name [Symbol] the name of the property
+    # @param options [Hash] property options
+    # @option options [Symbol] :type The property type
+    # @option options [Symbol] :default The default value for the property
+    # @return [void]
+    def add(name, options)
+      @properties[name.to_sym] = Property.new(name.to_sym, options[:type], options[:default])
+    end
+
+    # How many properties are defined
+    #
+    # @return [Fixnum] the number of defined properties
+    def size
+      @properties.size
+    end
+    alias_method :length, :size
+
+    def each_property(&block)
+      @properties.values.each(&block)
+    end
+    alias_method :each, :each_property
+
+    # Look up a property by name
+    #
+    # @param property_name [String] the name of the property
+    # @return [Property, nil] the property definition for property_name or nil
+    def find(property_name)
+      @properties[property_name.to_sym]
+    end
+    alias_method :[], :find
+  end
+end

data/lib/json_api_client/version.rb

@@ -1,3 +1,3 @@
 module JsonApiClient
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end

data/lib/json_api_client.rb

@@ -14,6 +14,7 @@ module JsonApiClient
   autoload :Query, 'json_api_client/query'
   autoload :Resource, 'json_api_client/resource'
   autoload :ResultSet, 'json_api_client/result_set'
+  autoload :Schema, 'json_api_client/schema'
   autoload :Scope, 'json_api_client/scope'
   autoload :Utils, 'json_api_client/utils'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: json_api_client
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Jeff Ching
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-25 00:00:00.000000000 Z
+date: 2014-08-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -91,6 +91,7 @@ files:
 - lib/json_api_client/helpers/linkable.rb
 - lib/json_api_client/helpers/parsable.rb
 - lib/json_api_client/helpers/queryable.rb
+- lib/json_api_client/helpers/schemable.rb
 - lib/json_api_client/helpers/serializable.rb
 - lib/json_api_client/link.rb
 - lib/json_api_client/link_definition.rb
@@ -110,6 +111,7 @@ files:
 - lib/json_api_client/query/update.rb
 - lib/json_api_client/resource.rb
 - lib/json_api_client/result_set.rb
+- lib/json_api_client/schema.rb
 - lib/json_api_client/scope.rb
 - lib/json_api_client/utils.rb
 - lib/json_api_client/version.rb