json-api-client 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7af31af9bdd82d1f44c25c01448ea3c6ced7c771
+  data.tar.gz: b401b8c2aae3412d2db4c19e3405bb0ecbe8b051
+SHA512:
+  metadata.gz: d2070691e0a2e74414ed834e02e0f977d2e9384d67400702005beaf7d7d222a049c8cf64b50c8e4a7fec18e6b0218d91dcf4efae4886975f364c0dc368ec7ce8
+  data.tar.gz: 0132dfb25f4b27fad1248b056e00dcdea592d4034888de12cfc9966130455388db3c4453483c006570b28409c0458cb22f74a59dbb84c682e78de89a0caef5c9

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in json-api-client.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,5 @@
+guard :rspec, cmd: "bundle exec rspec" do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 John Bohn
+
+MIT License
+
+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,29 @@
+# Json::Api::Client
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'json-api-client'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install json-api-client
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/json-api-client/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

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/json-api-client.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'json_api_client/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "json-api-client"
+  spec.version       = JsonApiClient::VERSION
+  spec.authors       = ["John Bohn"]
+  spec.email         = ["jjbohn@gmail.com"]
+  spec.summary       = %q{A client for working with json api spec based apis}
+  spec.description   = %q{A client for working with json api spec based apis}
+  spec.homepage      = "https://www.github.com/jjbohn/json-api-spec"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "guard"
+  spec.add_development_dependency "guard-rspec"
+
+  spec.add_dependency "activesupport"
+  spec.add_dependency "faraday"
+  spec.add_dependency "faraday_middleware"
+  spec.add_dependency "hashie"
+end

data/lib/json_api_client.rb

@@ -0,0 +1,8 @@
+module JsonApiClient
+end
+
+require "json_api_client/consumer"
+require "json_api_client/error"
+require "json_api_client/mapper"
+require "json_api_client/resource"
+require "json_api_client/version"

data/lib/json_api_client/consumer.rb

@@ -0,0 +1,35 @@
+require "faraday"
+require "faraday_middleware"
+
+module JsonApiClient
+  class Consumer
+    def initialize(name)
+      @name = name
+    end
+
+    def get(url, params = {})
+      connection.get(url, params) do |request|
+        request.headers["Content-Type"] = "application/vnd.api+json"
+      end
+    rescue Faraday::Error => e
+      raise "JsonApiClient::#{e.class.name.demodulize}".constantize.new(e)
+    end
+
+    def connection
+      @connection ||= Faraday.new(url: config(:base_url)).tap do |connection|
+        connection.authorization :Token, config(:token)
+        connection.use Faraday::Response::RaiseError
+        connection.use FaradayMiddleware::ParseJson, content_type: /\bjson$/
+      end
+    end
+
+    private
+
+    def config(key)
+      env_var = "#{@name}_#{key}".upcase
+      ENV.fetch(env_var)
+    rescue KeyError
+      raise KeyError.new("Environment variable #{env_var} was requested, but is not set")
+    end
+  end
+end

data/lib/json_api_client/error.rb

@@ -0,0 +1,49 @@
+module JsonApiClient
+  class Error < StandardError; end
+  class MissingDependency < Error; end
+
+  class ClientError < Error
+    def initialize(ex)
+      @wrapped_exception = nil
+
+      if ex.respond_to?(:backtrace)
+        super(ex.message)
+        @wrapped_exception = ex
+      elsif ex.respond_to?(:each_key)
+        super("the server responded with status #{ex[:status]}")
+      else
+        super(ex.to_s)
+      end
+    end
+
+    def backtrace
+      if @wrapped_exception
+        @wrapped_exception.backtrace
+      else
+        super
+      end
+    end
+
+    def inspect
+      %(#<#{self.class}>)
+    end
+  end
+
+  class ConnectionFailed < ClientError;   end
+  class ResourceNotFound < ClientError;   end
+  class ParsingError     < ClientError;   end
+
+  class TimeoutError < ClientError
+    def initialize(ex = nil)
+      super(ex || "timeout")
+    end
+  end
+
+  class SSLError < ClientError
+  end
+
+  [:MissingDependency, :ClientError, :ConnectionFailed, :ResourceNotFound,
+   :ParsingError, :TimeoutError, :SSLError].each do |const|
+    Error.const_set(const, JsonApiClient.const_get(const))
+  end
+end

data/lib/json_api_client/mapper.rb

@@ -0,0 +1,92 @@
+require "hashie/mash"
+require "active_support/inflector"
+
+module JsonApiClient
+  class Mapper
+    attr_reader :primary_resource, :primary_resource_methods
+
+    def initialize(primary_resource, primary_resource_methods = nil)
+      @classes = {}
+      @class_ids = {} # Keeps track of current class ids
+      @primary_resource = primary_resource
+      @primary_resource_methods = primary_resource_methods
+    end
+
+    def call(data, resource_type = primary_resource)
+      data.fetch(resource_type).map do |resource|
+        except_links = resource.reject { |k, _| k == "links" }
+
+        apply_linked_resources(resource, data, except_links)
+
+        build_resource(resource_type, except_links, &primary_resource_methods)
+      end
+    end
+
+    private
+
+    def build_resource(resource_type, hash, &primary_resource_methods)
+      Hashie::Mash.new(hash).tap do |mash|
+        mash.instance_exec(&primary_resource_methods) if primary_resource_methods
+      end
+    end
+
+    def apply_linked_resources(resource, data, hash)
+      return {} unless data["linked"]
+
+      link_type_map = build_link_type_map(data)
+
+      resource["links"].map do |association, id|
+        type = link_type_map[association]
+
+        if linked_resource = get_linked_resources(data, type, id)
+          hash[association.to_sym] = linked_resource
+        end
+      end
+    end
+
+    def get_linked_resources(data, type, id_or_ids)
+      map = build_linked_resources_map(data)
+
+      multiple = id_or_ids.is_a?(Array)
+
+      if multiple
+        id_or_ids.map{ |id| send(__method__, data, type, id) }
+      else
+        return unless resource = map[type] && map[type][id_or_ids]
+
+        value = call({ type => [resource].flatten}, type)
+
+        multiple ? value : value.first
+      end
+    end
+
+    # Builds a map to enable getting references by type and id
+    #
+    # eg.
+    # {
+    #   "users" => {
+    #     "1" => { "id" => "1", "name" => "John" },
+    #     "5" => { "id" => "5", "name" => "Walter" },
+    #   }
+    # }
+    def build_linked_resources_map(data)
+      data["linked"].each_with_object({}) do |(type, resources), obj|
+        obj[type] ||= {}
+        resources.each do |linked_resource|
+          obj[type][linked_resource["id"]] = linked_resource
+        end
+      end
+    end
+
+    # Builds a map to translate references to types
+    #
+    # eg.
+    # { "author" => "users", "comments" => "comments" }
+    def build_link_type_map(data)
+      data["links"].each_with_object({}) do |(key, value), obj|
+        association = key.split(".").last
+        obj[association] = value["type"].pluralize
+      end
+    end
+  end
+end

data/lib/json_api_client/resource.rb

@@ -0,0 +1,30 @@
+module JsonApiClient
+  module Resource
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      def api_client
+        @api_client ||= Consumer.new(@resource_config_prefix)
+      end
+
+      def mapper
+        @mapper ||= Mapper.new(resource, @resource_methods)
+      end
+
+      def resource(resource = nil)
+        @resource = String(resource) unless resource.nil?
+        @resource
+      end
+
+      def resource_config_prefix(resource_config_prefix)
+        @resource_config_prefix = String(resource_config_prefix)
+      end
+
+      def resource_methods(&block)
+        @resource_methods = block
+      end
+    end
+  end
+end

data/lib/json_api_client/version.rb

@@ -0,0 +1,3 @@
+module JsonApiClient
+  VERSION = "0.0.2"
+end

data/spec/json_api_client/consumer_spec.rb

@@ -0,0 +1,69 @@
+require "spec_helper"
+
+describe JsonApiClient::Consumer do
+  subject(:consumer){ described_class.new("resource_api") }
+
+  before(:each) do
+    stub_const("ENV", {
+      "RESOURCE_API_BASE_URL" => "https://example.com/api",
+      "RESOURCE_API_TOKEN" => "token",
+    })
+  end
+
+  describe "#connection" do
+    it "builds a Faraday connection with an authorization header" do
+      connection = consumer.connection
+
+      expect(connection.headers["Authorization"]).to eql("Token token")
+      expect(connection.builder.handlers).to include(FaradayMiddleware::ParseJson)
+    end
+
+    it "memoizes the connection response" do
+      expect(consumer.connection).to equal(consumer.connection)
+    end
+  end
+
+  describe "#get" do
+    it "it call a GET request on the connection" do
+      connection = Faraday.new do |builder|
+        builder.adapter :test do |stub|
+          stub.get("/foo"){ [200, { "Accept" => "application/vnd.api+json" }, "bar"] }
+        end
+      end
+
+      allow(consumer).to receive(:connection).and_return(connection)
+      expect(consumer.get("foo").body).to eql("bar")
+    end
+
+    it "forwards params" do
+      response = double(body: "response")
+
+      expect(consumer.connection).to receive(:get).with("http://google.com", foo: "bar").and_return(response)
+      expect(consumer.get("http://google.com", foo: "bar").body).to eql("response")
+    end
+
+    it "merges params" do
+      response = double(body: "response")
+
+      expect(consumer.connection).to receive(:get).with("http://google.com?test=param", foo: "bar").and_return(response)
+      expect(consumer.get("http://google.com?test=param", foo: "bar").body).to eql("response")
+    end
+
+    context "when there is a Faraday::Error" do
+      it "raises it's own error" do
+        allow(consumer.connection).to receive(:get).and_raise(Faraday::Error)
+
+        expect{ consumer.get("/foo") }.to raise_error(JsonApiClient::Error)
+      end
+    end
+
+    context "when there is a Faraday::Error::ConnectionError" do
+      it "raises it's own error" do
+        original_error = double
+        allow(consumer.connection).to receive(:get).and_raise(Faraday::Error::ConnectionFailed.new(double))
+
+        expect{ consumer.get("/foo") }.to raise_error(JsonApiClient::Error::ConnectionFailed)
+      end
+    end
+  end
+end

data/spec/json_api_client/mapper_spec.rb

@@ -0,0 +1,112 @@
+require "spec_helper"
+
+describe JsonApiClient::Mapper do
+  let(:data) do
+    {
+      "resources" => [
+        { "property" => "foo" },
+        { "property" => "bar" },
+      ],
+    }
+  end
+
+  describe "#call" do
+    it "generates a new resource and maps the values" do
+      mapper = described_class.new("resources")
+      resources = mapper.call(data)
+
+      expect(resources.length).to eql(2)
+      expect(resources.first.property).to eql("foo")
+      expect(resources.last.property).to eql("bar")
+    end
+
+    context "if extra resource methods are passed" do
+      it "makes those methods available" do
+        methods = Proc.new{ def custom_method; "biz" end }
+        mapper = described_class.new("resources", methods)
+
+        resources = mapper.call(data)
+        expect(resources.first.custom_method).to eql("biz")
+      end
+
+      it "can overwrite existing properties" do
+        methods = Proc.new{ def property; "biz" end }
+        mapper = described_class.new("resources", methods)
+
+        resources = mapper.call(data)
+        expect(resources.first.property).to eql("biz")
+      end
+    end
+  end
+
+  context "with a compound object" do
+    subject(:mapper){ described_class.new("posts") }
+
+    context "with singular linked resource" do
+      let(:data) do
+        {
+          "links" => {
+            "posts.author" => {
+              "href" => "http://example.com/users/{posts.author}",
+              "type" => "user",
+            },
+            "posts.comments" => {
+              "href" => "http://example.com/comments/{posts.comments}",
+              "type" => "comments",
+            }
+          },
+          "posts" => [{
+            "id" => "1",
+            "links" => {
+              "author" => "1",
+              "comments" => ["1", "2"],
+            },
+            "id" => "3",
+            "links" => {
+              "author" => "1",
+              "comments" => ["1", "2"],
+            },
+          }, {
+              "id" => "2",
+              "extra" => "3",
+              "links" => {
+                "author" => "1",
+                "comments" => ["3"],
+              },
+            }],
+            "linked" => {
+              "users" => [{
+                "id" => "1",
+                "name" => "John",
+              }],
+              "comments" => [{
+                "id" => "1",
+                "body" => "foo",
+              }, {
+                "id" => "2",
+                "body" => "bar",
+              }, {
+                "id" => "3",
+                "body" => "baz",
+              }],
+            }
+        }
+      end
+
+      it "maps the linked resources" do
+        posts = mapper.call(data)
+        expect(posts[0].author).to_not be_nil
+        expect(posts[0].author.id).to eql("1")
+        expect(posts[0].author.name).to eql("John")
+        expect(posts[1].author).to eql(posts[0].author)
+
+        expect(posts[0].comments[0].id).to eql("1")
+        expect(posts[0].comments[0].body).to eql("foo")
+        expect(posts[0].comments[1].id).to eql("2")
+        expect(posts[0].comments[1].body).to eql("bar")
+        expect(posts[1].comments[0].id).to eql("3")
+        expect(posts[1].comments[0].body).to eql("baz")
+      end
+    end
+  end
+end

data/spec/json_api_client/resource_spec.rb

@@ -0,0 +1,31 @@
+require "spec_helper"
+
+describe JsonApiClient::Resource do
+  subject(:expected_proc){}
+  subject(:resource) do
+    Class.new do
+      include (JsonApiClient::Resource)
+      resource :foo
+      resource_config_prefix :foo_api
+      resource_methods do
+        def custom_method; end
+      end
+    end
+  end
+
+  it "creates a mapper" do
+    mapper = resource.mapper
+
+    expect(mapper).to be_kind_of(JsonApiClient::Mapper)
+    expect(resource.mapper).to equal(mapper)
+    expect(mapper.primary_resource).to eql("foo")
+
+  end
+
+  it "creates a consumer" do
+    consumer = resource.api_client
+
+    expect(consumer).to be_kind_of(JsonApiClient::Consumer)
+    expect(resource.api_client).to equal(consumer)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,23 @@
+require "rspec"
+require_relative "../lib/json_api_client"
+
+RSpec.configure do |config|
+  config.filter_run :none
+  config.run_all_when_everything_filtered = true
+
+  if config.files_to_run.one?
+    config.default_formatter = 'doc'
+  end
+
+  config.order = :random
+  Kernel.srand config.seed
+
+  config.expect_with :rspec do |expectations|
+    expectations.syntax = :expect
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.syntax = :expect
+    mocks.verify_partial_doubles = true
+  end
+end

metadata

@@ -0,0 +1,192 @@
+--- !ruby/object:Gem::Specification
+name: json-api-client
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- John Bohn
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: guard
+  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'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A client for working with json api spec based apis
+email:
+- jjbohn@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- json-api-client.gemspec
+- lib/json_api_client.rb
+- lib/json_api_client/consumer.rb
+- lib/json_api_client/error.rb
+- lib/json_api_client/mapper.rb
+- lib/json_api_client/resource.rb
+- lib/json_api_client/version.rb
+- spec/json_api_client/consumer_spec.rb
+- spec/json_api_client/mapper_spec.rb
+- spec/json_api_client/resource_spec.rb
+- spec/spec_helper.rb
+homepage: https://www.github.com/jjbohn/json-api-spec
+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.2.2
+signing_key: 
+specification_version: 4
+summary: A client for working with json api spec based apis
+test_files:
+- spec/json_api_client/consumer_spec.rb
+- spec/json_api_client/mapper_spec.rb
+- spec/json_api_client/resource_spec.rb
+- spec/spec_helper.rb
+has_rdoc: