json-api-reader 0.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.gitignore +9 -0
- data/.rspec +2 -0
- data/.travis.yml +4 -0
- data/Gemfile +4 -0
- data/README.md +52 -0
- data/Rakefile +6 -0
- data/bin/console +14 -0
- data/bin/setup +8 -0
- data/json-api-reader.gemspec +38 -0
- data/lib/json_api_reader.rb +11 -0
- data/lib/json_api_reader/error.rb +7 -0
- data/lib/json_api_reader/fetcher.rb +32 -0
- data/lib/json_api_reader/page_result.rb +31 -0
- data/lib/json_api_reader/reader.rb +32 -0
- data/lib/json_api_reader/version.rb +3 -0
- metadata +172 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: a965ed59724bfeb05b01b5fe7bb01094f6c1ead3
|
4
|
+
data.tar.gz: 33ef803dcf48b53fef2c8265c114fde3ab374ba1
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 94fbefccdbeea72037073e150abf96625a46081ed1a13135a2c5cb01511e46a4b4c60c3c33d4056dc7636ee253a91f9c244a9d73b79b9b925b06728ea6732681
|
7
|
+
data.tar.gz: 41a446b9c9910483d42db5460e321511203e000b516e2fac5a0c4f44841b5b28fcd02d81589ae2ffcfb93ab4b2248ccf409776cff24cc7cc5586698816f11b05
|
data/.gitignore
ADDED
data/.rspec
ADDED
data/.travis.yml
ADDED
data/Gemfile
ADDED
data/README.md
ADDED
@@ -0,0 +1,52 @@
|
|
1
|
+
# JsonApiReader
|
2
|
+
|
3
|
+
A simple json-api client.
|
4
|
+
|
5
|
+
## Installation
|
6
|
+
|
7
|
+
Add this line to your application's Gemfile:
|
8
|
+
|
9
|
+
```ruby
|
10
|
+
gem 'json-api-reader'
|
11
|
+
```
|
12
|
+
|
13
|
+
And then execute:
|
14
|
+
|
15
|
+
$ bundle
|
16
|
+
|
17
|
+
Or install it yourself as:
|
18
|
+
|
19
|
+
$ gem install json-api-reader
|
20
|
+
|
21
|
+
## Usage
|
22
|
+
Get all pages from a json-api endpoint.
|
23
|
+
```ruby
|
24
|
+
JsonApiReader::Reader.all_pages(endpoint: 'https://my-endpoint.com/api/v1/foos',
|
25
|
+
headers: {'Authorization' => 'Bearer mytoken'}) do |page_result|
|
26
|
+
# page_result is instance of JsonApiReader::PageResult
|
27
|
+
page_result.attributes.each do |attributes|
|
28
|
+
MyModel.create(attributes)
|
29
|
+
end
|
30
|
+
end
|
31
|
+
```
|
32
|
+
|
33
|
+
Or get just one page
|
34
|
+
```ruby
|
35
|
+
page_result = JsonApiReader::Reader.first_page(endpoint: 'https://my-endpoint.com/api/v1/foos')
|
36
|
+
```
|
37
|
+
|
38
|
+
Query parameters can be added with **query** parameter
|
39
|
+
```ruby
|
40
|
+
page_result = JsonApiReader::Reader.first_page(endpoint: 'https://my-endpoint.com/api/v1/foos', query: {page: 1, per_page: 100})
|
41
|
+
```
|
42
|
+
|
43
|
+
## Development
|
44
|
+
|
45
|
+
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.
|
46
|
+
|
47
|
+
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).
|
48
|
+
|
49
|
+
## Contributing
|
50
|
+
|
51
|
+
Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/json-api-reader.
|
52
|
+
|
data/Rakefile
ADDED
data/bin/console
ADDED
@@ -0,0 +1,14 @@
|
|
1
|
+
#!/usr/bin/env ruby
|
2
|
+
|
3
|
+
require "bundler/setup"
|
4
|
+
require "json_api_reader"
|
5
|
+
|
6
|
+
# You can add fixtures and/or initialization code here to make experimenting
|
7
|
+
# with your gem easier. You can also use a different console, if you like.
|
8
|
+
|
9
|
+
# (If you use this, don't forget to add pry to your Gemfile!)
|
10
|
+
# require "pry"
|
11
|
+
# Pry.start
|
12
|
+
|
13
|
+
require "irb"
|
14
|
+
IRB.start
|
data/bin/setup
ADDED
@@ -0,0 +1,38 @@
|
|
1
|
+
# coding: utf-8
|
2
|
+
lib = File.expand_path('../lib', __FILE__)
|
3
|
+
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
4
|
+
require 'json_api_reader/version'
|
5
|
+
|
6
|
+
Gem::Specification.new do |spec|
|
7
|
+
spec.name = "json-api-reader"
|
8
|
+
spec.version = JsonApiReader::VERSION
|
9
|
+
spec.authors = ["Perry Hertler"]
|
10
|
+
spec.email = ["perry@hertler.org"]
|
11
|
+
|
12
|
+
spec.summary = %q{Reads JSON API endpoints.}
|
13
|
+
spec.description = %q{Reads JSON API endpoints.}
|
14
|
+
spec.homepage = ""
|
15
|
+
|
16
|
+
# Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
|
17
|
+
# delete this section to allow pushing this gem to any host.
|
18
|
+
if spec.respond_to?(:metadata)
|
19
|
+
spec.metadata['allowed_push_host'] = 'https://rubygems.org'
|
20
|
+
else
|
21
|
+
raise 'RubyGems 2.0 or newer is required to protect against public gem pushes.'
|
22
|
+
end
|
23
|
+
|
24
|
+
spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
|
25
|
+
spec.bindir = "exe"
|
26
|
+
spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
|
27
|
+
spec.require_paths = ["lib"]
|
28
|
+
|
29
|
+
spec.add_development_dependency 'bundler', '~> 1.11'
|
30
|
+
spec.add_development_dependency 'rake', '~> 10.0'
|
31
|
+
spec.add_development_dependency 'rspec', '~> 3.0'
|
32
|
+
spec.add_development_dependency 'rspec-its'
|
33
|
+
spec.add_development_dependency 'pry'
|
34
|
+
spec.add_development_dependency 'webmock'
|
35
|
+
spec.add_development_dependency 'climate_control'
|
36
|
+
|
37
|
+
spec.add_dependency 'httparty'
|
38
|
+
end
|
@@ -0,0 +1,32 @@
|
|
1
|
+
module JsonApiReader
|
2
|
+
class Fetcher
|
3
|
+
def initialize(url, options={})
|
4
|
+
@url = url
|
5
|
+
@options = options
|
6
|
+
end
|
7
|
+
|
8
|
+
class << self
|
9
|
+
def fetch_all(url, options={})
|
10
|
+
new(url, options).fetch_all
|
11
|
+
end
|
12
|
+
end
|
13
|
+
|
14
|
+
def fetch_all
|
15
|
+
response = HTTParty.get(@url, query: query, headers: headers)
|
16
|
+
|
17
|
+
raise JsonApiReader::RecordNotFoundError.new("404 - URL: '#{@url}'") if 404 == response.code
|
18
|
+
raise JsonApiReader::Error.new("#{response.code} returned from URL: '#{@url}'") if response.code >= 400
|
19
|
+
JsonApiReader::PageResult.new JSON.parse(response.body)
|
20
|
+
end
|
21
|
+
|
22
|
+
def headers
|
23
|
+
{'Content-Type' => 'application/json',
|
24
|
+
'Accept' => 'application/json'}.
|
25
|
+
merge(@options[:headers] || {})
|
26
|
+
end
|
27
|
+
|
28
|
+
def query
|
29
|
+
@options[:query]
|
30
|
+
end
|
31
|
+
end
|
32
|
+
end
|
@@ -0,0 +1,31 @@
|
|
1
|
+
module JsonApiReader
|
2
|
+
class PageResult
|
3
|
+
def initialize(result_hash)
|
4
|
+
@result_hash = result_hash
|
5
|
+
end
|
6
|
+
|
7
|
+
def attributes
|
8
|
+
@attributes ||= data.collect { |data_att| data_att['attributes'] }
|
9
|
+
end
|
10
|
+
|
11
|
+
def attributes_by_type(the_type)
|
12
|
+
attributes.select do |att|
|
13
|
+
the_type == att['type']
|
14
|
+
end
|
15
|
+
end
|
16
|
+
|
17
|
+
def next_url
|
18
|
+
links['next']
|
19
|
+
end
|
20
|
+
|
21
|
+
def self_url
|
22
|
+
links['self']
|
23
|
+
end
|
24
|
+
|
25
|
+
[:data, :meta, :links].each do |method|
|
26
|
+
define_method(method) do
|
27
|
+
@result_hash[method.to_s]
|
28
|
+
end
|
29
|
+
end
|
30
|
+
end
|
31
|
+
end
|
@@ -0,0 +1,32 @@
|
|
1
|
+
module JsonApiReader
|
2
|
+
class Reader
|
3
|
+
def initialize(options={}, block)
|
4
|
+
raise ArgumentError.new("'endpoint' option is required") if options[:endpoint].nil?
|
5
|
+
@url = options[:endpoint]
|
6
|
+
@options = options.clone
|
7
|
+
@block = block
|
8
|
+
end
|
9
|
+
|
10
|
+
def all_pages
|
11
|
+
while !@url.nil?
|
12
|
+
@url = fetch.next_url
|
13
|
+
end
|
14
|
+
end
|
15
|
+
|
16
|
+
def fetch
|
17
|
+
result = JsonApiReader::Fetcher.fetch_all(@url, @options)
|
18
|
+
@block.call(result)
|
19
|
+
result
|
20
|
+
end
|
21
|
+
|
22
|
+
class << self
|
23
|
+
def all_pages(options={}, &block)
|
24
|
+
new(options, block).all_pages
|
25
|
+
end
|
26
|
+
|
27
|
+
def first_page(options={}, &block)
|
28
|
+
new(options, block).fetch
|
29
|
+
end
|
30
|
+
end
|
31
|
+
end
|
32
|
+
end
|
metadata
ADDED
@@ -0,0 +1,172 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: json-api-reader
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.1.0
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- Perry Hertler
|
8
|
+
autorequire:
|
9
|
+
bindir: exe
|
10
|
+
cert_chain: []
|
11
|
+
date: 2016-09-07 00:00:00.000000000 Z
|
12
|
+
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
name: bundler
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - "~>"
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: '1.11'
|
20
|
+
type: :development
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - "~>"
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: '1.11'
|
27
|
+
- !ruby/object:Gem::Dependency
|
28
|
+
name: rake
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
30
|
+
requirements:
|
31
|
+
- - "~>"
|
32
|
+
- !ruby/object:Gem::Version
|
33
|
+
version: '10.0'
|
34
|
+
type: :development
|
35
|
+
prerelease: false
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
37
|
+
requirements:
|
38
|
+
- - "~>"
|
39
|
+
- !ruby/object:Gem::Version
|
40
|
+
version: '10.0'
|
41
|
+
- !ruby/object:Gem::Dependency
|
42
|
+
name: rspec
|
43
|
+
requirement: !ruby/object:Gem::Requirement
|
44
|
+
requirements:
|
45
|
+
- - "~>"
|
46
|
+
- !ruby/object:Gem::Version
|
47
|
+
version: '3.0'
|
48
|
+
type: :development
|
49
|
+
prerelease: false
|
50
|
+
version_requirements: !ruby/object:Gem::Requirement
|
51
|
+
requirements:
|
52
|
+
- - "~>"
|
53
|
+
- !ruby/object:Gem::Version
|
54
|
+
version: '3.0'
|
55
|
+
- !ruby/object:Gem::Dependency
|
56
|
+
name: rspec-its
|
57
|
+
requirement: !ruby/object:Gem::Requirement
|
58
|
+
requirements:
|
59
|
+
- - ">="
|
60
|
+
- !ruby/object:Gem::Version
|
61
|
+
version: '0'
|
62
|
+
type: :development
|
63
|
+
prerelease: false
|
64
|
+
version_requirements: !ruby/object:Gem::Requirement
|
65
|
+
requirements:
|
66
|
+
- - ">="
|
67
|
+
- !ruby/object:Gem::Version
|
68
|
+
version: '0'
|
69
|
+
- !ruby/object:Gem::Dependency
|
70
|
+
name: pry
|
71
|
+
requirement: !ruby/object:Gem::Requirement
|
72
|
+
requirements:
|
73
|
+
- - ">="
|
74
|
+
- !ruby/object:Gem::Version
|
75
|
+
version: '0'
|
76
|
+
type: :development
|
77
|
+
prerelease: false
|
78
|
+
version_requirements: !ruby/object:Gem::Requirement
|
79
|
+
requirements:
|
80
|
+
- - ">="
|
81
|
+
- !ruby/object:Gem::Version
|
82
|
+
version: '0'
|
83
|
+
- !ruby/object:Gem::Dependency
|
84
|
+
name: webmock
|
85
|
+
requirement: !ruby/object:Gem::Requirement
|
86
|
+
requirements:
|
87
|
+
- - ">="
|
88
|
+
- !ruby/object:Gem::Version
|
89
|
+
version: '0'
|
90
|
+
type: :development
|
91
|
+
prerelease: false
|
92
|
+
version_requirements: !ruby/object:Gem::Requirement
|
93
|
+
requirements:
|
94
|
+
- - ">="
|
95
|
+
- !ruby/object:Gem::Version
|
96
|
+
version: '0'
|
97
|
+
- !ruby/object:Gem::Dependency
|
98
|
+
name: climate_control
|
99
|
+
requirement: !ruby/object:Gem::Requirement
|
100
|
+
requirements:
|
101
|
+
- - ">="
|
102
|
+
- !ruby/object:Gem::Version
|
103
|
+
version: '0'
|
104
|
+
type: :development
|
105
|
+
prerelease: false
|
106
|
+
version_requirements: !ruby/object:Gem::Requirement
|
107
|
+
requirements:
|
108
|
+
- - ">="
|
109
|
+
- !ruby/object:Gem::Version
|
110
|
+
version: '0'
|
111
|
+
- !ruby/object:Gem::Dependency
|
112
|
+
name: httparty
|
113
|
+
requirement: !ruby/object:Gem::Requirement
|
114
|
+
requirements:
|
115
|
+
- - ">="
|
116
|
+
- !ruby/object:Gem::Version
|
117
|
+
version: '0'
|
118
|
+
type: :runtime
|
119
|
+
prerelease: false
|
120
|
+
version_requirements: !ruby/object:Gem::Requirement
|
121
|
+
requirements:
|
122
|
+
- - ">="
|
123
|
+
- !ruby/object:Gem::Version
|
124
|
+
version: '0'
|
125
|
+
description: Reads JSON API endpoints.
|
126
|
+
email:
|
127
|
+
- perry@hertler.org
|
128
|
+
executables: []
|
129
|
+
extensions: []
|
130
|
+
extra_rdoc_files: []
|
131
|
+
files:
|
132
|
+
- ".gitignore"
|
133
|
+
- ".rspec"
|
134
|
+
- ".travis.yml"
|
135
|
+
- Gemfile
|
136
|
+
- README.md
|
137
|
+
- Rakefile
|
138
|
+
- bin/console
|
139
|
+
- bin/setup
|
140
|
+
- json-api-reader.gemspec
|
141
|
+
- lib/json_api_reader.rb
|
142
|
+
- lib/json_api_reader/error.rb
|
143
|
+
- lib/json_api_reader/fetcher.rb
|
144
|
+
- lib/json_api_reader/page_result.rb
|
145
|
+
- lib/json_api_reader/reader.rb
|
146
|
+
- lib/json_api_reader/version.rb
|
147
|
+
homepage: ''
|
148
|
+
licenses: []
|
149
|
+
metadata:
|
150
|
+
allowed_push_host: https://rubygems.org
|
151
|
+
post_install_message:
|
152
|
+
rdoc_options: []
|
153
|
+
require_paths:
|
154
|
+
- lib
|
155
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
156
|
+
requirements:
|
157
|
+
- - ">="
|
158
|
+
- !ruby/object:Gem::Version
|
159
|
+
version: '0'
|
160
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
161
|
+
requirements:
|
162
|
+
- - ">="
|
163
|
+
- !ruby/object:Gem::Version
|
164
|
+
version: '0'
|
165
|
+
requirements: []
|
166
|
+
rubyforge_project:
|
167
|
+
rubygems_version: 2.4.5
|
168
|
+
signing_key:
|
169
|
+
specification_version: 4
|
170
|
+
summary: Reads JSON API endpoints.
|
171
|
+
test_files: []
|
172
|
+
has_rdoc:
|