json_api_resource 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8de53cf54fc4d7b2dac22f9412edab5c7e9f468c
+  data.tar.gz: 6d3d904ef873a695ec4140739de2c89e29523c9f
+SHA512:
+  metadata.gz: 203292b024a04149a33e06d93bbf0dbe4623c9db4aff903f23d1d2f5a96215879a7c531b962cab75b1b14a1bbf493d0d437a723e0f279e3b539c20e8c758e284
+  data.tar.gz: 94e8199d4670a43fb50a1ef5d2da834ea30822a4f8f617386d3940b1242a4c6868fcd738f573c7b9d8fce3cafe53f7f13185405526de7e7637e58fce4265798f

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Avvo, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

data/README.md

@@ -0,0 +1,17 @@
+# JsonApiResource
+
+Common code wrapper object or Adapter class to extend a JsonApiClient::Resource
+
+## Usage
+
+### Basic
+
+```
+class Customer < JsonApiResource::Resource
+  property :name => 'name', :email => '', :permissions => []
+  api_client Ledger::Client::Customer
+end
+
+item = Customer.new
+#<Customer:0x007f84b7a72568 @client=#<Ledger::Client::Customer:0x007f84b7a71398 @attributes={"id"=>nil, "name"=>"name", "email"=>"", "permissions"=>[]}>>
+

data/Rakefile

@@ -0,0 +1,12 @@
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task :default => :test

data/lib/json_api_resource/cacheable.rb

@@ -0,0 +1,8 @@
+module JsonApiResource
+  module Cacheable
+    extend ActiveSupport::Concern
+    def cache_key
+      @cache_key ||= Digest::SHA256.hexdigest(self.to_json)
+    end
+  end
+end

data/lib/json_api_resource/conversions.rb

@@ -0,0 +1,75 @@
+module JsonApiResource
+  module Conversions
+    def Address(*args)
+      case args.first
+        when Address then args.first
+        when Hash then Address.new(args.first)
+        when Address.client then Address.new(args.first.attributes)
+        when Array then args.first.map { |attr| Address(attr) }
+        when Integer then Address.new(* args)
+        when String then Address.new(* args.first.split(':'). map(&:to_i))
+        else raise TypeError, "Cannot convert #{ args.inspect} to Address"
+      end
+    end
+
+    def ApiErrors(*args)
+      case args.first
+        when ActiveModel::Errors then args.first
+        when Hash then args.first
+        when Array then { base: args }
+        when String then { base: [args] }
+        else raise TypeError, "Cannot convert #{ args.inspect} to Error"
+      end
+    end
+
+    def Date(*args)
+      case args.first
+        when String then Date.parse(args.first)
+        when Date then args.first
+        else raise TypeError, "Cannot convert #{ args.inspect} to Date"
+      end
+    end
+
+    def DateTime(*args)
+      case args.first
+        when String then DateTime.parse(args.first)
+        when DateTime then args.first
+        else raise TypeError, "Cannot convert #{ args.inspect} to DateTime"
+      end
+    end
+
+    def Boolean(*args)
+      case args.first
+        when FalseClass then args.first
+        when TrueClass then args.first
+        when String
+          if %w(true 1).include?(args.first.downcase)
+            true
+          elsif %w(false 0).include?(args.first.downcase)
+            false
+          else
+            raise TypeError, "Cannot convert #{ args.inspect} to Boolean"
+          end
+        when Integer then args.first != 0
+        else raise TypeError, "Cannot convert #{ args.inspect} to Boolean"
+      end
+    end
+
+    def Symbolize(*args)
+      case args.first
+        when String then args.first.underscore.parameterize('_').to_sym
+        else args.first
+      end
+    end
+
+    def ApiResource(klass, *args)
+      case args.first
+        when klass then args.first
+        when Hash then klass.new(args.first)
+        when klass.client then klass.new(args.first.attributes)
+        when Array then args.first.map { |attr| JsonApiResource(attr, klass) }
+        else raise TypeError, "Cannot convert #{ args.inspect} to #{klass}"
+      end
+    end
+  end
+end

data/lib/json_api_resource/queryable.rb

@@ -0,0 +1,79 @@
+module JsonApiResource
+  module Queryable
+    extend ActiveSupport::Concern
+
+    attr_accessor :meta
+    attr_accessor :linked_data
+    attr_accessor :errors
+
+    module ClassMethods
+
+      include JsonApiResource::Conversions
+
+      def find(id)
+        return nil unless id.present?
+        results = self.client_klass.find(id).map! do |result|
+          self.new(:client => result)
+        end
+        results.size == 1 ? single_result(results) : results
+      rescue JsonApiClient::Errors::ServerError => e
+        pretty_error e
+      end
+
+      def create(attr = {})
+        run_callbacks :create do
+          new(:client => self.client_klass.create(attr))
+        end
+      end
+
+      def where(opts = {})
+        opts[:per_page] = opts.fetch(:per_page, self.per_page)
+        (self.client_klass.where(opts).all).map! do |result|
+          self.new(:client => result)
+        end
+      rescue JsonApiClient::Errors::ServerError => e
+        pretty_error e
+      end
+
+      private
+
+      # When we return a collection, these extra attributes on top of the result array from JsonApiClient are present.
+      # When we find just one thing and return the first element like ActiveRecord would,
+      # we lose these things.  We want them, so we will assign them to this object.
+      def single_result(results)
+        result = results.first
+
+        result.meta = results.meta
+
+        result.linked_data = results.linked_data if results.respond_to? :linked_data
+
+        return result
+      end
+
+      def pretty_error(e)
+        case e.class.to_s
+
+        when 'JsonApiClient::Errors::NotFound'
+          error_response 404, { name: "RecordNotFound", message: e.message }
+
+        when 'JsonApiClient::Errors::UnexpectedStatus'
+          error_response e.code, { name: "UnexpectedStatus", message: e.message }
+
+        else
+          error_response 500, { name: "ServerError", message: e.message }
+        end
+      end
+
+      def error_response(status, error)
+        result = JsonApiClient::ResultSet.new
+
+        result.meta = {status: status}
+
+        result.errors = ActiveModel::Errors.new(result)
+        result.errors.add(error[:name], Array(error[:message]).join(', '))
+
+        result
+      end
+    end
+  end
+end

data/lib/json_api_resource/resource.rb

@@ -0,0 +1,108 @@
+module JsonApiResource
+  class Resource
+    include ActiveModel::Model
+    include ActiveModel::Validations
+    extend  ActiveModel::Callbacks
+
+    include JsonApiResource::Schemable
+    include JsonApiResource::Queryable
+    include JsonApiResource::Conversions
+    include JsonApiResource::Cacheable
+
+    attr_accessor :client, :cache_expires_in
+    class_attribute :client_klass, :per_page
+
+    define_model_callbacks :save, :create, :update_attributes
+
+    around_create :catch_errors
+    around_save   :catch_errors
+    around_update_attributes :catch_errors
+
+    def initialize(opts={})
+      self.client = self.client_klass.new(self.schema)
+      self.errors = ActiveModel::Errors.new(self)
+      self.attributes = opts
+    end
+
+    def new_record?
+      self.id.nil?
+    end
+
+    def persisted?
+      !new_record?
+    end
+
+    def save
+      run_callbacks :save do
+        self.client.save
+      end
+    end
+
+    def update_attributes(attrs = {})
+      run_callbacks :update_attributes do
+        self.client.update_attributes(attrs)
+      end
+    end
+
+    def attributes=(attr = {})
+      client_params = attr.delete(:client)
+      if attr.is_a? self.client_klass
+        self.client = attr
+      elsif client_params
+        self.client = client_params
+      else
+        self.client.attributes = attr
+      end
+    end
+
+    protected
+
+    def method_missing(method, *args, &block)
+      if match = method.to_s.match(/^(.*=)$/)
+        self.client.send(match[1], args.first)
+      elsif self.client.respond_to?(method.to_sym)
+        is_method = self.client.methods.include?(method.to_sym)
+        argument_count = (is_method ? self.client.method(method.to_sym).arity : 0)
+        argument_count = args.length if argument_count == -1
+        if (argument_count == 0) || args.blank?
+          self.client.send(method)
+        else
+          self.client.send(method, *args.take(argument_count))
+        end
+      else
+        super
+      end
+    end
+
+    def catch_errors
+      yield
+
+      self.errors ||= ActiveModel::Errors.new(self)
+      ApiErrors(self.client.errors).each do | k,messages|
+        self.errors.add(k.to_sym, Array(messages).join(', '))
+      end
+      self.errors
+    end
+
+    def self.method_missing(method, *args, &block)
+      if match = method.to_s.match(/^(.*)=$/)
+        self.client_klass.send(match[1], args.first)
+      
+      elsif self.client_klass.respond_to?(method.to_sym)
+        results = self.client_klass.send(method, *args)
+
+        if results.is_a? JsonApiClient::ResultSet
+          results.map! do |result|
+            self.new(:client => result)
+          end
+        end
+        results
+      else
+        super
+      end
+
+    rescue JsonApiClient::Errors::ServerError => e
+      pretty_error e
+    end
+  end
+end

data/lib/json_api_resource/schemable.rb

@@ -0,0 +1,26 @@
+module JsonApiResource
+  module Schemable
+
+    extend ActiveSupport::Concern
+
+    included do
+      class_attribute :schema
+      self.schema = {}
+    end
+
+    module ClassMethods
+      def property(opts = {})
+        opts.each do |attr_name,default|
+          self.schema[attr_name.to_sym] = default || nil
+        end
+      end
+    end
+
+    protected
+
+    def load_schema
+      self.client = self.client_klass.new(self.schema)
+    end
+
+  end
+end

data/lib/json_api_resource/version.rb

@@ -0,0 +1,3 @@
+module JsonApiResource
+  VERSION = "0.4.0"
+end

data/lib/json_api_resource.rb

@@ -0,0 +1,9 @@
+require 'json_api_client'
+
+module JsonApiResource
+  autoload :Conversions,  'json_api_resource/conversions'
+  autoload :Queryable,    'json_api_resource/queryable'
+  autoload :Schemable,    'json_api_resource/schemable'
+  autoload :Resource,     'json_api_resource/resource'
+  autoload :Cacheable,    'json_api_resource/cacheable'
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: json_api_resource
+version: !ruby/object:Gem::Version
+  version: 0.4.0
+platform: ruby
+authors:
+- Brandon Sislow
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-08-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json_api_client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: json_api_client_mock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Wrapper Gem to extend the JsonApiClient::Resource
+email: brandon.silsow@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- Rakefile
+- lib/json_api_resource.rb
+- lib/json_api_resource/cacheable.rb
+- lib/json_api_resource/conversions.rb
+- lib/json_api_resource/queryable.rb
+- lib/json_api_resource/resource.rb
+- lib/json_api_resource/schemable.rb
+- lib/json_api_resource/version.rb
+homepage: http://gitlab.corp.avvo.com/api/api_resource
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: Build wrapper/adapter objects around JsonApiClient instances
+test_files: []
+has_rdoc: