json_api_client-legacy 1.0.0.beta

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: db01b6871d441bfbeb6088d8adfdb01f2aa3650c
+  data.tar.gz: 764f2a807a96b1a6f7724fe703279f5941340f35
+SHA512:
+  metadata.gz: 0b706948566acbd5e7dbfb65dd5361d0713d33f893339c3b602b51b800a5fec6958a3d87b1c02369def8905d180b7597a98cb9ac86c76085050b48f2fab014f2
+  data.tar.gz: 422aa93b68cf1c6bf6f68e11449798dcfa8cd9fa2ca4ec5fd64922a1005e7893034ccb662628fe01fefc00c17522f842cd34503ca05755ebc4e1579408372428

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.1

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in json_api_client-legacy.gemspec
+gemspec
+
+gem "json_api_client"

data/README.md

@@ -0,0 +1,39 @@
+# JsonApiClient::Legacy
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/json_api_client/legacy`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'json_api_client-legacy'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install json_api_client-legacy
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/json_api_client-legacy/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,13 @@
+require "bundler/gem_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/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "json_api_client/legacy"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/json_api_client-legacy.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'json_api_client/legacy/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "json_api_client-legacy"
+  spec.version       = JsonApiClient::Legacy::VERSION
+  spec.authors       = ["Jeff Ching"]
+  spec.email         = ["ching.jeff@gmail.com"]
+
+  spec.summary       = %q{Customizations for json_api_client 1.0.0 to handle 0.x servers}
+  spec.description   = %q{Customizations for json_api_client 1.0.0 to handle 0.x servers}
+  spec.homepage      = "https://github.com/chingor13/json_api_client-legacy"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "json_api_client", "~> 1.0.0.beta"
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "webmock"
+  spec.add_development_dependency "mocha"
+end

data/lib/json_api_client-legacy.rb

@@ -0,0 +1 @@
+require 'json_api_client/legacy'

data/lib/json_api_client/legacy.rb

@@ -0,0 +1,16 @@
+require "json_api_client"
+require "json_api_client/legacy/version"
+
+module JsonApiClient
+  module Legacy
+    autoload :Base, "json_api_client/legacy/base"
+    autoload :Connection, "json_api_client/legacy/connection"
+    autoload :LinkDefinition, "json_api_client/legacy/link_definition"
+    autoload :LinkedData, "json_api_client/legacy/linked_data"
+    autoload :Linker, "json_api_client/legacy/linker"
+    autoload :Paginator, "json_api_client/legacy/paginator"
+    autoload :Parser, "json_api_client/legacy/parser"
+    autoload :QueryBuilder, "json_api_client/legacy/query_builder"
+    autoload :Requestor, "json_api_client/legacy/requestor"
+  end
+end

data/lib/json_api_client/legacy/base.rb

@@ -0,0 +1,18 @@
+module JsonApiClient
+  module Legacy
+    class Base < Resource
+      self.connection_class = JsonApiClient::Legacy::Connection
+      self.linker = JsonApiClient::Legacy::Linker
+      self.parser = JsonApiClient::Legacy::Parser
+      self.paginator = JsonApiClient::Legacy::Paginator
+      self.query_builder = JsonApiClient::Legacy::QueryBuilder
+      self.requestor_class = JsonApiClient::Legacy::Requestor
+
+      protected
+
+      def self.default_attributes
+        {}
+      end
+    end
+  end
+end

data/lib/json_api_client/legacy/connection.rb

@@ -0,0 +1,35 @@
+module JsonApiClient
+  module Legacy
+    class Connection
+
+      attr_reader :faraday
+
+      def initialize(options = {})
+        site = options.fetch(:site)
+        @faraday = Faraday.new(site) do |builder|
+          builder.request :json
+          builder.use Middleware::Status
+          builder.use Middleware::ParseJson
+          builder.adapter Faraday.default_adapter
+        end
+        yield(self) if block_given?
+      end
+
+      # insert middleware before ParseJson - middleware executed in reverse order -
+      #   inserted middleware will run after json parsed
+      def use(middleware, *args, &block)
+        return if faraday.builder.locked?
+        faraday.builder.insert_before(Middleware::ParseJson, middleware, *args, &block)
+      end
+
+      def delete(middleware)
+        faraday.builder.delete(middleware)
+      end
+
+      def run(request_method, path, params = {}, headers = {})
+        faraday.send(request_method, path, params, headers)
+      end
+
+    end
+  end
+end

data/lib/json_api_client/legacy/link_definition.rb

@@ -0,0 +1,29 @@
+module JsonApiClient
+  module Legacy
+    class LinkDefinition
+
+      def initialize(spec)
+        @spec = {}.with_indifferent_access
+        spec.each do |type, definition|
+          @spec[type.split(".").last] = definition.merge({slurp: type})
+        end
+      end
+
+      def has_link?(type)
+        @spec.has_key?(type)
+      end
+
+      def attribute_name_for(type)
+        @spec.fetch(type).fetch("type")
+      end
+
+      def url_for(type, ids)
+        definition = @spec.fetch(type)
+        href = definition.fetch("href")
+        slurp = definition.fetch("slurp")
+        href.gsub("{#{slurp}}", Array(ids).join(","))
+      end
+
+    end
+  end
+end

data/lib/json_api_client/legacy/linked_data.rb

@@ -0,0 +1,69 @@
+# This object holds the preloaded data from the json response - essentially
+#   the preloaded foreign keys
+module JsonApiClient
+  module Legacy
+    class LinkedData
+      attr_reader :link_definition,
+                  :record_class
+
+      extend Forwardable
+      def_delegators :link_definition, :has_link?
+
+      def initialize(data, link_definition, record_class)
+        @link_definition = link_definition
+        @record_class = record_class
+        @results_by_type_by_id = {}
+
+        data.each do |type, results|
+          klass = klass_for(type)
+          add_data(type, results.map{|result| klass.new(result)})
+        end
+      end
+
+      def data_for(type, ids)
+        ids = Array(ids)
+
+        # the name of the linked data is provided by the link definition from the result
+        attr_name = link_definition.attribute_name_for(type)
+
+        # get any preloaded data from the result
+        type_data = @results_by_type_by_id.fetch(attr_name, {})
+
+        # find the associated class for the data
+        klass = klass_for(type)
+
+        # return all the found records
+        found, missing = ids.partition { |id| type_data[id].present? }
+
+        # make another api request if there are missing records
+        fetch_data(klass, type, missing) if missing.present?
+
+        # reload data
+        type_data = @results_by_type_by_id.fetch(attr_name, {})
+
+        ids.map do |id|
+          type_data[id]
+        end
+      end
+
+      # make an api request to fetch the missing data
+      def fetch_data(klass, type, missing_ids)
+        path = URI(link_definition.url_for(type, missing_ids)).path
+
+        results = klass.requestor.linked(path)
+
+        key = link_definition.attribute_name_for(type).to_s
+        add_data(key, results)
+      end
+
+      def add_data(key, data)
+        @results_by_type_by_id[key] ||= {}
+        @results_by_type_by_id[key].merge!(data.index_by{|datum| datum["id"]})
+      end
+
+      def klass_for(type)
+        Utils.compute_type(record_class, type.to_s.pluralize.classify)
+      end
+    end
+  end
+end

data/lib/json_api_client/legacy/linker.rb

@@ -0,0 +1,16 @@
+module JsonApiClient
+  module Legacy
+    class Linker
+      include Helpers::DynamicAttributes
+
+      def initialize(links)
+        self.attributes = links
+      end
+
+      def present?
+        attributes.present?
+      end
+
+    end
+  end
+end

data/lib/json_api_client/legacy/paginator.rb

@@ -0,0 +1,71 @@
+module JsonApiClient
+  module Legacy
+    class Paginator
+      attr_reader :meta, :result_set
+      def initialize(result_set, meta)
+        @meta = meta
+        @result_set = result_set
+      end
+
+      def next
+        raise NotImplementedError
+      end
+
+      def prev
+        raise NotImplementedError
+      end
+
+      def first
+        raise NotImplementedError
+      end
+
+      def last
+        raise NotImplementedError
+      end
+
+      def total_pages
+        meta.fetch("total_pages") do
+          (1.0 * total_entries / per_page).ceil rescue 1
+        end
+      end
+
+      def total_entries
+        meta.fetch("total_entries") do
+          result_set.length
+        end
+      end
+
+      def offset
+        meta.fetch("offset") do
+          per_page * (current_page - 1)
+        end
+      end
+
+      def per_page
+        meta.fetch("per_page") do
+          result_set.length
+        end
+      end
+
+      def current_page
+        meta.fetch("current_page") do
+          meta.fetch("page", 1)
+        end
+      end
+
+      def out_of_bounds?
+        current_page > total_pages
+      end
+
+      def previous_page
+        current_page > 1 ? (current_page - 1) : nil
+      end
+
+      def next_page
+        current_page < total_pages ? (current_page + 1) : nil
+      end
+
+      alias limit_value per_page
+    end
+  end
+end

data/lib/json_api_client/legacy/parser.rb

@@ -0,0 +1,61 @@
+module JsonApiClient
+  module Legacy
+    class Parser
+
+      class << self
+        def parse(klass, response)
+          data = response.body
+          ResultSet.new.tap do |result_set|
+            result_set.record_class = klass
+            result_set.uri = response.env[:url]
+            handle_data(result_set, data)
+            handle_meta(result_set, data)
+            handle_pagination(result_set, data)
+            handle_links(result_set, data)
+            handle_errors(result_set, data)
+          end
+        end
+
+        private
+
+        def handle_data(result_set, data)
+          # data can live under the table name or the generic "data" key
+          results = data.fetch(result_set.record_class.table_name) do
+            results.fetch("data", [])
+          end
+
+          # we will treat everything as an Array
+          results = [results] unless results.is_a?(Array)
+          result_set.concat(results.map{|res| result_set.record_class.load(res)})
+        end
+
+        def handle_meta(result_set, data)
+          result_set.meta = data.fetch("meta", {})
+        end
+
+        def handle_pagination(result_set, data)
+          result_set.pages = result_set.record_class.paginator.new(result_set, result_set.meta)
+        end
+
+        def handle_links(result_set, data)
+          return if result_set.empty?
+
+          linked_data = LinkedData.new(
+                          data.fetch("linked", {}),
+                          LinkDefinition.new(data.fetch("links", {})),
+                          result_set.record_class
+                        )
+
+          result_set.each do |resource|
+            resource.linked_data = linked_data
+          end
+        end
+
+        def handle_errors(result_set, data)
+          result_set.errors = result_set.meta.fetch("errors", [])
+        end
+      end
+
+    end
+  end
+end

data/lib/json_api_client/legacy/query_builder.rb

@@ -0,0 +1,51 @@
+module JsonApiClient
+  module Legacy
+    class QueryBuilder
+
+      attr_reader :klass, :params
+
+      def initialize(klass)
+        @klass = klass
+        @params = {}
+      end
+
+      def where(conditions = {})
+        @params.merge!(conditions)
+        self
+      end
+      alias paginate where
+
+      def order(conditions)
+        where(order: conditions)
+      end
+
+      def includes(*tables)
+        @params[:includes] ||= []
+        @params[:includes] += tables.flatten
+        self
+      end
+
+      def page(number)
+        where(page: number)
+      end
+
+      def first
+        paginate(page: 1, per_page: 1).to_a.first
+      end
+
+      def build
+        klass.new(params)
+      end
+
+      def to_a
+        @to_a ||= klass.find(params)
+      end
+      alias all to_a
+
+      def method_missing(method_name, *args, &block)
+        to_a.send(method_name, *args, &block)
+      end
+
+    end
+  end
+end

data/lib/json_api_client/legacy/requestor.rb

@@ -0,0 +1,77 @@
+module JsonApiClient
+  module Legacy
+    class Requestor
+      extend Forwardable
+
+      def initialize(klass)
+        @klass = klass
+      end
+
+      # expects a record
+      def create(record)
+        request(:post, klass.path(record.attributes), {
+          klass.resource_name => record.attributes
+        })
+      end
+
+      def update(record)
+        request(:put, resource_path(record.attributes), {
+          klass.resource_name => record.attributes.except(klass.primary_key)
+        })
+      end
+
+      def find(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
+
+        path = resource_path(params)
+        params.delete(klass.primary_key)
+        request(:get, path, params)
+      end
+
+      def destroy(record)
+        request(:delete, resource_path(record.attributes), {})
+      end
+
+      def linked(path)
+        request(:get, path, {})
+      end
+
+      def custom(method_name, options, params)
+        path = resource_path(params)
+        params.delete(klass.primary_key)
+        path = File.join(path, method_name.to_s)
+
+        request(options.fetch(:request_method, :get), path, params)
+      end
+
+      protected
+
+      attr_reader :klass
+      def_delegators :klass, :connection
+
+      def resource_path(parameters)
+        if resource_id = parameters[klass.primary_key]
+          File.join(klass.path(parameters), encoded(resource_id))
+        else
+          klass.path(parameters)
+        end
+      end
+
+      def encoded(part)
+        Addressable::URI.encode_component(part, Addressable::URI::CharacterClasses::UNRESERVED)
+      end
+
+      def request(type, path, params)
+        klass.parse(connection.run(type, path, params))
+      end
+
+    end
+  end
+end

data/lib/json_api_client/legacy/version.rb

@@ -0,0 +1,5 @@
+module JsonApiClient
+  module Legacy
+    VERSION = "1.0.0.beta"
+  end
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: json_api_client-legacy
+version: !ruby/object:Gem::Version
+  version: 1.0.0.beta
+platform: ruby
+authors:
+- Jeff Ching
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-05-05 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: 1.0.0.beta
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0.beta
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  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: Customizations for json_api_client 1.0.0 to handle 0.x servers
+email:
+- ching.jeff@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- json_api_client-legacy.gemspec
+- lib/json_api_client-legacy.rb
+- lib/json_api_client/legacy.rb
+- lib/json_api_client/legacy/base.rb
+- lib/json_api_client/legacy/connection.rb
+- lib/json_api_client/legacy/link_definition.rb
+- lib/json_api_client/legacy/linked_data.rb
+- lib/json_api_client/legacy/linker.rb
+- lib/json_api_client/legacy/paginator.rb
+- lib/json_api_client/legacy/parser.rb
+- lib/json_api_client/legacy/query_builder.rb
+- lib/json_api_client/legacy/requestor.rb
+- lib/json_api_client/legacy/version.rb
+homepage: https://github.com/chingor13/json_api_client-legacy
+licenses: []
+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: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Customizations for json_api_client 1.0.0 to handle 0.x servers
+test_files: []
+has_rdoc: