jsonapi-consumer 0.1.0.pre.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: caaedec2074ee4aafca24c5afea80f6ae9422c49
+  data.tar.gz: f38a0c0d33691186de1b2ecf24603a0132a52925
+SHA512:
+  metadata.gz: 4326500565a0f142502c2db9ac40084875f3345942e97ea7fe5ab3b505d9193e8289f49fd481aaffb836e929bb0aa2a9f50aec27f5a162df50e2c7b9e73a2a90
+  data.tar.gz: 06ab89c5bddfe9bfad758b1ddf4a21d6ff3c74ff6dbeb01684f03b8a714a740dc1f408c3322e339b03baef315df42593cc7c3f690af08d7780bc590999d1b0b1

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/CHANGELOG.md

@@ -0,0 +1,12 @@
+
+0.1.0.pre (unreleased) / 2014-10-19
+==================
+
+  * Add yarddoc to associations_concern
+  * Add error handling and parsing of Bad Requests
+  * Parse `has_one` and `has_many` links attribute from JSONAPI
+  * CRUD is supported
+  * Support create, find, all finders
+  * Create query support
+  * Basic serialization and association building.
+

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in jsonapi-consumer.gemspec
+gemspec
+
+gem 'fsevent'
+gem 'guard-rspec', require: false

data/LICENSE.txt

@@ -0,0 +1,176 @@
+                                Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS

data/README.md

@@ -0,0 +1,37 @@
+# JSONAPI::Consumer
+
+An ActiveModel-compliant consumer framework for communicating with JSONAPI-based APIs.
+
+[![Build Status](https://travis-ci.org/jsmestad/jsonapi-consumer.svg?branch=master)](https://travis-ci.org/jsmestad/jsonapi-consumer)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'jsonapi-consumer'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install jsonapi-consumer
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/jsmestad/jsonapi-consumer/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+## Copyright & License
+
+JSONAPI::Consumer is distributed under the Apache 2.0 License. See LICENSE.txt file for more information.

data/Rakefile

@@ -0,0 +1,12 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end
+

data/jsonapi-consumer.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'jsonapi/consumer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "jsonapi-consumer"
+  spec.version       = Jsonapi::Consumer::VERSION
+  spec.authors       = ["Justin Smestad"]
+  spec.email         = ["justin.smestad@gmail.com"]
+  spec.summary       = %q{JSONAPI client framework for API consumption.}
+  spec.description   = %q{Create ActiveModel-compliant objects for your JSONAPI-based API}
+  spec.homepage      = "https://github.com/jsmestad/jsonapi-consumer"
+  spec.license       = "Apache-2.0"
+
+  spec.files         = `git ls-files -z`.split("\x0") - ['Guardfile', '.travis.yml']
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "activemodel"
+  spec.add_runtime_dependency "activesupport"
+  spec.add_runtime_dependency "faraday", "~> 0.9.0"
+  spec.add_runtime_dependency "faraday_middleware"
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "factory_girl"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rspec-its"
+  spec.add_development_dependency "webmock"
+end

data/lib/jsonapi/consumer/errors.rb

@@ -0,0 +1,98 @@
+# JSONAPI::Consumer::Errors is responsible for wrapping API errors into a consistent
+# form. Handling or Rescuing from these errors is left up to the client, but
+# a possible way to do this is detailed below.
+#
+#  # lib/errors/rescue_error.rb
+#  module Errors
+#    module RescueError
+#
+#      def self.included(base)
+#        base.rescue_from Errors::ResponseError do |e|
+#          render "public/#{e.code}", :status => e.code
+#        end
+#      end
+#
+#    end
+#  end
+#
+module JSONAPI::Consumer
+  module Errors
+    class ConnectionNotConfigured < StandardError; end
+    class RecordNotSaved < StandardError; end
+
+    class ServerNotResponding < StandardError
+      def message
+        'Server did not respond in a timely fashion. Is it running?'
+      end
+    end
+
+    # Error constants
+    BAD_REQUEST                     = 400
+    NOT_AUTHORIZED                  = 401
+    FORBIDDEN                       = 403
+    NOT_FOUND                       = 404
+    METHOD_NOT_ALLOWED              = 405
+    BAD_FORMAT                      = 406
+    REQUESTED_RANGE_NOT_SATISFIABLE = 416
+    UNPROCESSABLE_ENTITY            = 422
+    INTERNAL_SERVER_ERROR           = 500
+
+    # Base subclass for all response errors
+    class ResponseError < StandardError
+      attr_accessor :response
+
+      def initialize(message=nil, response=nil)
+        super(message)
+        self.response = response
+      end
+
+      def errors
+        response[:body].fetch('errors', [])
+      end
+
+      def response_body
+        response[:body]
+      end
+    end
+
+    class << self
+
+      # Returns a hash of error names to response codes.
+      def error_constants
+        constants.each_with_object({}) do |name, hash|
+          # Ignore any class constants
+          next if (code = Errors.const_get(name)).is_a?(Class)
+          hash[name] = code
+        end
+      end
+
+      # Returns a class name from a constant name.
+      def class_name_for_error_name(name)
+        name.to_s.titleize.gsub(' ', '')
+      end
+
+      # Returns the error class for a given constant name.
+      # Default to InternalServerError.
+      def class_for_error_name(name)
+        class_name = class_name_for_error_name(name)
+        const_defined?(class_name) ? Errors.const_get(class_name) : Errors::InternalServerError
+      end
+
+      # Returns the error class for a given error code.
+      # Default to InternalServerError.
+      def class_for_error_code(code)
+        name = error_constants.select { |k, v| v == code }.keys.first
+        name.present? ? class_for_error_name(name) : Errors::InternalServerError
+      end
+    end
+  end
+
+  # Dynamically creates a subclass of ResponseError for each error constant.
+  # Adds a code method to return the correct response code.
+  # Adds the new class to the constants in the Errors module.
+  Errors.error_constants.each do |name, code|
+    klass = Class.new(Errors::ResponseError)
+    klass.send(:define_method, :code) { code }
+    Errors.const_set(Errors.class_name_for_error_name(name), klass)
+  end
+end

data/lib/jsonapi/consumer/middleware/parse_json.rb

@@ -0,0 +1,32 @@
+module JSONAPI::Consumer::Middleware
+  # Credit to chingor13/json_api_client for middleware.
+  #
+  class ParseJson < Faraday::Response::Middleware
+
+    def call(environment)
+      @app.call(environment).on_complete do |env|
+        if process_response_type?(response_type(env))
+          env[:raw_body] = env[:body]
+          env[:body] = parse(env[:body])
+        end
+      end
+    end
+
+  private
+
+    def parse(body)
+      ::JSON.parse(body) unless body.strip.empty?
+    end
+
+    def response_type(env)
+      type = env[:response_headers]['Content-Type'].to_s
+      type = type.split(';', 2).first if type.index(';')
+      type
+    end
+
+    def process_response_type?(type)
+      !!type.match(/\bjson$/)
+    end
+  end
+end
+

data/lib/jsonapi/consumer/middleware/raise_error.rb

@@ -0,0 +1,21 @@
+module JSONAPI::Consumer::Middleware
+  class RaiseError < Faraday::Response::Middleware
+    def on_complete(env)
+      return if (status = env[:status]) < 400
+      message = "#{env[:status]} #{env[:method].upcase} #{env[:url]} #{env[:body]}"
+      raise ::JSONAPI::Consumer::Errors.class_for_error_code(status).new(message, response_values(env))
+    end
+
+    def response_values(env)
+      {status: env[:status], headers: env[:response_headers], body: parse_body(env[:body])}
+    end
+
+    def parse_body(body)
+      if body.nil?
+        nil
+      else
+        JSON.parse(body) rescue nil
+      end
+    end
+  end
+end

data/lib/jsonapi/consumer/middleware/request_timeout.rb

@@ -0,0 +1,9 @@
+module JSONAPI::Consumer::Middleware
+  class RequestTimeout < Faraday::Middleware
+    def call(env)
+      @app.call(env)
+    rescue Faraday::TimeoutError
+      raise JSONAPI::Consumer::Errors::ServerNotResponding
+    end
+  end
+end

data/lib/jsonapi/consumer/middleware.rb

@@ -0,0 +1,5 @@
+module JSONAPI::Consumer
+  module Middleware
+
+  end
+end

data/lib/jsonapi/consumer/parser.rb

@@ -0,0 +1,75 @@
+module JSONAPI::Consumer
+  class Parser
+    attr_reader :response, :klass
+
+    def initialize(klass, response)
+      @klass = klass
+      @response = response
+    end
+
+    def attributes(item)
+      item.except(:links)
+    end
+
+    def associations(item)
+      associations = {}
+      item.fetch(:links, {}).each do |assoc_name, ids|
+        associations[assoc_name] = if ids.is_a?(Array)
+                                     ids.collect {|id| find_linked(assoc_name, id) }
+                                   else
+                                     find_linked(assoc_name, ids)
+                                   end
+      end
+      associations
+    end
+
+    def fetch_resource
+      link_body = _body.fetch(:links, {})
+
+      links = {}
+
+      link_body.each do |key, url|
+        links[key.split('.').last] = url
+      end
+
+      links
+    end
+
+    def fetch_linked(assoc_name, id)
+      klass._association_class_name(assoc_name).find(id)
+    end
+
+    def find_linked(assoc_name, id)
+      if found = linked.fetch(assoc_name, []).detect {|h| h.fetch(:id) == id }
+        klass._association_class_name(assoc_name).new(found)
+      else
+        fetch_linked(assoc_name, id)
+      end
+    end
+
+    def linked
+      linked_body = _body.fetch(:linked, {})
+
+      linked = {}
+      linked_body.each do |key, obj_attrs|
+        linked[key] = obj_attrs
+      end
+      linked
+    end
+
+    def build
+      _body.fetch(klass.json_key, []).collect do |attrs|
+        attrs_hash = attributes(attrs).merge(associations(attrs))
+        klass.new(attrs_hash)
+      end
+    end
+
+    def _body
+      response.body.with_indifferent_access
+    end
+
+    def _status
+      reponse.status
+    end
+  end
+end

data/lib/jsonapi/consumer/query/base.rb

@@ -0,0 +1,34 @@
+module JSONAPI::Consumer::Query
+  class Base
+    class << self
+      attr_accessor :request_method
+    end
+    attr_reader :klass, :headers, :path, :params
+
+    def initialize(klass, payload)
+      @klass = klass
+      build_params(payload) if payload.is_a?(Hash) && payload.keys != [klass.primary_key]
+
+      @path = begin
+                if payload.is_a?(Hash) && payload.has_key?(klass.primary_key)
+                  [klass.path, payload.delete(klass.primary_key)].join('/')
+                else
+                  klass.path
+                end
+              end
+    end
+
+    def build_params(args)
+      @params = args.dup
+    end
+
+    def request_method
+      self.class.request_method
+    end
+
+    def inspect
+      "#{self.class.name}: method: #{request_method}; path: #{path}; params: #{params}, headers: #{headers}"
+    end
+
+  end
+end

data/lib/jsonapi/consumer/query/create.rb

@@ -0,0 +1,9 @@
+module JSONAPI::Consumer::Query
+  class Create < Base
+    self.request_method = :post
+
+    def build_params(args)
+      @params = {klass.json_key => args}
+    end
+  end
+end

data/lib/jsonapi/consumer/query/delete.rb

@@ -0,0 +1,10 @@
+module JSONAPI::Consumer::Query
+  class Delete < Base
+    self.request_method = :delete
+
+    def params
+      nil
+    end
+  end
+end
+

data/lib/jsonapi/consumer/query/find.rb

@@ -0,0 +1,16 @@
+module JSONAPI::Consumer::Query
+  class Find < Base
+    self.request_method = :get
+
+    def build_params(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
+    end
+  end
+end

data/lib/jsonapi/consumer/query/new.rb

@@ -0,0 +1,15 @@
+module JSONAPI::Consumer::Query
+  class New < Base
+    self.request_method = :get
+
+    def initialize(klass, payload)
+      super
+      @path = [klass.path, 'new'].join('/')
+    end
+
+    # def build_params(args)
+      # @params = {klass.json_key => args}
+    # end
+  end
+end
+

data/lib/jsonapi/consumer/query/update.rb

@@ -0,0 +1,11 @@
+module JSONAPI::Consumer::Query
+  class Update < Base
+    self.request_method = :put
+
+    def build_params(args)
+      args = args.dup
+      @params = {klass.json_key => args.except(klass.primary_key)}
+    end
+  end
+end
+

data/lib/jsonapi/consumer/query.rb

@@ -0,0 +1,5 @@
+module JSONAPI::Consumer
+  module Query
+
+  end
+end