json-api-reader 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a965ed59724bfeb05b01b5fe7bb01094f6c1ead3
+  data.tar.gz: 33ef803dcf48b53fef2c8265c114fde3ab374ba1
+SHA512:
+  metadata.gz: 94fbefccdbeea72037073e150abf96625a46081ed1a13135a2c5cb01511e46a4b4c60c3c33d4056dc7636ee253a91f9c244a9d73b79b9b925b06728ea6732681
+  data.tar.gz: 41a446b9c9910483d42db5460e321511203e000b516e2fac5a0c4f44841b5b28fcd02d81589ae2ffcfb93ab4b2248ccf409776cff24cc7cc5586698816f11b05

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2

data/Gemfile

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

data/README.md

@@ -0,0 +1,52 @@
+# JsonApiReader
+
+A simple json-api client.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'json-api-reader'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install json-api-reader
+
+## Usage
+Get all pages from a json-api endpoint. 
+```ruby
+JsonApiReader::Reader.all_pages(endpoint: 'https://my-endpoint.com/api/v1/foos', 
+                                headers: {'Authorization' => 'Bearer mytoken'}) do |page_result|
+  # page_result is instance of JsonApiReader::PageResult                                
+  page_result.attributes.each do |attributes|
+    MyModel.create(attributes)
+  end
+end
+```
+
+Or get just one page
+```ruby
+page_result = JsonApiReader::Reader.first_page(endpoint: 'https://my-endpoint.com/api/v1/foos')
+```
+
+Query parameters can be added with **query** parameter
+```ruby
+page_result = JsonApiReader::Reader.first_page(endpoint: 'https://my-endpoint.com/api/v1/foos', query: {page: 1, per_page: 100})
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also 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`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/json-api-reader.
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "json_api_reader"
+
+# 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,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/json-api-reader.gemspec

@@ -0,0 +1,38 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'json_api_reader/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "json-api-reader"
+  spec.version       = JsonApiReader::VERSION
+  spec.authors       = ["Perry Hertler"]
+  spec.email         = ["perry@hertler.org"]
+
+  spec.summary       = %q{Reads JSON API endpoints.}
+  spec.description   = %q{Reads JSON API endpoints.}
+  spec.homepage      = ""
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against public gem pushes.'
+  end
+
+  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_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rspec-its'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'webmock'
+  spec.add_development_dependency 'climate_control'
+
+  spec.add_dependency 'httparty'
+end

data/lib/json_api_reader.rb

@@ -0,0 +1,11 @@
+require 'json_api_reader/version'
+require 'httparty'
+
+module JsonApiReader
+
+end
+
+require 'json_api_reader/page_result'
+require 'json_api_reader/error'
+require 'json_api_reader/fetcher'
+require 'json_api_reader/reader'

data/lib/json_api_reader/error.rb

@@ -0,0 +1,7 @@
+module JsonApiReader
+  class Error < StandardError
+  end
+
+  class RecordNotFoundError < Error
+  end
+end

data/lib/json_api_reader/fetcher.rb

@@ -0,0 +1,32 @@
+module JsonApiReader
+  class Fetcher
+    def initialize(url, options={})
+      @url     = url
+      @options = options
+    end
+
+    class << self
+      def fetch_all(url, options={})
+        new(url, options).fetch_all
+      end
+    end
+
+    def fetch_all
+      response = HTTParty.get(@url, query: query, headers: headers)
+
+      raise JsonApiReader::RecordNotFoundError.new("404 - URL: '#{@url}'") if 404 == response.code
+      raise JsonApiReader::Error.new("#{response.code} returned from URL: '#{@url}'") if response.code >= 400
+      JsonApiReader::PageResult.new JSON.parse(response.body)
+    end
+
+    def headers
+      {'Content-Type' => 'application/json',
+       'Accept'       => 'application/json'}.
+          merge(@options[:headers] || {})
+    end
+
+    def query
+      @options[:query]
+    end
+  end
+end

data/lib/json_api_reader/page_result.rb

@@ -0,0 +1,31 @@
+module JsonApiReader
+  class PageResult
+    def initialize(result_hash)
+      @result_hash = result_hash
+    end
+
+    def attributes
+      @attributes ||= data.collect { |data_att| data_att['attributes'] }
+    end
+
+    def attributes_by_type(the_type)
+      attributes.select do |att|
+        the_type == att['type']
+      end
+    end
+
+    def next_url
+      links['next']
+    end
+
+    def self_url
+      links['self']
+    end
+
+    [:data, :meta, :links].each do |method|
+      define_method(method) do
+        @result_hash[method.to_s]
+      end
+    end
+  end
+end

data/lib/json_api_reader/reader.rb

@@ -0,0 +1,32 @@
+module JsonApiReader
+  class Reader
+    def initialize(options={}, block)
+      raise ArgumentError.new("'endpoint' option is required") if options[:endpoint].nil?
+      @url     = options[:endpoint]
+      @options = options.clone
+      @block   = block
+    end
+
+    def all_pages
+      while !@url.nil?
+        @url = fetch.next_url
+      end
+    end
+
+    def fetch
+      result = JsonApiReader::Fetcher.fetch_all(@url, @options)
+      @block.call(result)
+      result
+    end
+
+    class << self
+      def all_pages(options={}, &block)
+        new(options, block).all_pages
+      end
+
+      def first_page(options={}, &block)
+        new(options, block).fetch
+      end
+    end
+  end
+end

data/lib/json_api_reader/version.rb

@@ -0,0 +1,3 @@
+module JsonApiReader
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,172 @@
+--- !ruby/object:Gem::Specification
+name: json-api-reader
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Perry Hertler
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-09-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  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: pry
+  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: 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: climate_control
+  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: httparty
+  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: Reads JSON API endpoints.
+email:
+- perry@hertler.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- json-api-reader.gemspec
+- lib/json_api_reader.rb
+- lib/json_api_reader/error.rb
+- lib/json_api_reader/fetcher.rb
+- lib/json_api_reader/page_result.rb
+- lib/json_api_reader/reader.rb
+- lib/json_api_reader/version.rb
+homepage: ''
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+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.5
+signing_key: 
+specification_version: 4
+summary: Reads JSON API endpoints.
+test_files: []
+has_rdoc: