v-makeleaps-ruby 0.1.6
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.gitignore +13 -0
- data/.rspec +3 -0
- data/.travis.yml +10 -0
- data/Gemfile +4 -0
- data/LICENSE.txt +21 -0
- data/README.md +142 -0
- data/Rakefile +6 -0
- data/bin/console +14 -0
- data/bin/setup +8 -0
- data/lib/makeleaps/client.rb +29 -0
- data/lib/makeleaps/errors.rb +23 -0
- data/lib/makeleaps/request/base.rb +15 -0
- data/lib/makeleaps/request/basic_auth.rb +35 -0
- data/lib/makeleaps/request/generic.rb +90 -0
- data/lib/makeleaps/request/request_handler.rb +54 -0
- data/lib/makeleaps/request/url_manager.rb +37 -0
- data/lib/makeleaps/request.rb +2 -0
- data/lib/makeleaps/response/access_token.rb +38 -0
- data/lib/makeleaps/response/hash_access_delegator.rb +14 -0
- data/lib/makeleaps/response/meta_information.rb +15 -0
- data/lib/makeleaps/response/resource.rb +30 -0
- data/lib/makeleaps/response/wrapper.rb +27 -0
- data/lib/makeleaps/response.rb +2 -0
- data/lib/makeleaps/version.rb +3 -0
- data/lib/makeleaps.rb +6 -0
- data/makeleaps-ruby.gemspec +44 -0
- metadata +205 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: 6d40f2e9fec50ce6cb831c90ec005f91cbfcb745c9863a1a8f32c74cca429323
|
4
|
+
data.tar.gz: da75e75079cc3089271cc22c2f39cb109dbc7c40593c0376353a3cafca865884
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: ae1f7d717107d1a21bf3523e5144749317d0b07883c60bf3ae564c68a3cbadea5de8b14019e4810b17ac1b01d5008e4b7a658d2b422cd54e4fd6af2994232645
|
7
|
+
data.tar.gz: 5deb1239a60d686e9fc58f2796f12e2dca7a0adcaff446f9bdc24c62e50b909d5bf1aaf7d5104d3f2a8312f991de08d8640bc1fcd60664e65b5b52699c9d1f65
|
data/.gitignore
ADDED
data/.rspec
ADDED
data/.travis.yml
ADDED
data/Gemfile
ADDED
data/LICENSE.txt
ADDED
@@ -0,0 +1,21 @@
|
|
1
|
+
The MIT License (MIT)
|
2
|
+
|
3
|
+
Copyright (c) 2019 Koji Onishi
|
4
|
+
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
7
|
+
in the Software without restriction, including without limitation the rights
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
10
|
+
furnished to do so, subject to the following conditions:
|
11
|
+
|
12
|
+
The above copyright notice and this permission notice shall be included in
|
13
|
+
all copies or substantial portions of the Software.
|
14
|
+
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
21
|
+
THE SOFTWARE.
|
data/README.md
ADDED
@@ -0,0 +1,142 @@
|
|
1
|
+
[![GitHub tag (latest SemVer)](https://img.shields.io/badge/tag-v0.1.5-brightgreen)](https://img.shields.io/badge/tag-v0.1.5-brightgreen)
|
2
|
+
[![MIT Licence](https://img.shields.io/github/license/vareal/makeleaps-ruby)](https://img.shields.io/github/license/vareal/makeleaps-ruby)
|
3
|
+
|
4
|
+
# Note
|
5
|
+
This repository has been forked from the original repository [Makeleaps Ruby](https://github.com/zeals-co-ltd/makeleaps-ruby) and continues to develop since the original repository has stopped supporting and developing
|
6
|
+
|
7
|
+
# Makeleaps Ruby
|
8
|
+
|
9
|
+
A simple ruby client for [Makeleaps API](https://app.makeleaps.com/api/docs/).
|
10
|
+
|
11
|
+
* Note: this is NOT an official library, but an OSS maintained by third party developers. Please use it as your own risk.
|
12
|
+
|
13
|
+
## Installation
|
14
|
+
|
15
|
+
Add this line to your application's Gemfile:
|
16
|
+
|
17
|
+
```ruby
|
18
|
+
gem 'v-makeleaps-ruby'
|
19
|
+
```
|
20
|
+
|
21
|
+
And then execute:
|
22
|
+
|
23
|
+
$ bundle
|
24
|
+
|
25
|
+
Or install it yourself as:
|
26
|
+
|
27
|
+
$ gem install v-makeleaps-ruby
|
28
|
+
|
29
|
+
## Usage
|
30
|
+
|
31
|
+
```ruby
|
32
|
+
require 'makeleaps'
|
33
|
+
|
34
|
+
# establish connection using access token
|
35
|
+
client = Makeleaps::Client.new('your client-id','your client-secret')
|
36
|
+
client.connect!
|
37
|
+
|
38
|
+
# specify your parter_mid (you need to set one to access various resouces)
|
39
|
+
client.set_partner!(name: 'your_company_name')
|
40
|
+
|
41
|
+
# to disconnect (revokes access token)
|
42
|
+
client.disconnect!
|
43
|
+
```
|
44
|
+
|
45
|
+
### Examples
|
46
|
+
|
47
|
+
Refer to the [official API document](https://app.makeleaps.com/api/docs/) for detailed API reference.
|
48
|
+
|
49
|
+
#### GET (a single instance)
|
50
|
+
|
51
|
+
```ruby
|
52
|
+
client.get '/api/partner/xxxxxxx/document/yyyyyy/'
|
53
|
+
|
54
|
+
# below are actually the same request
|
55
|
+
client.get '/api/partner/xxxxxxx/document/yyyyyy/' # direct access (path)
|
56
|
+
client.get 'https://api.makeleaps.com/api/partner/xxxxxxx/document/yyyyyy/' # direct access (full url)
|
57
|
+
client.get :document, yyyyy # endpoints can also be referred as symbols
|
58
|
+
```
|
59
|
+
* in the last example, (<partner_mid> is automatically supplied after #set_partner! is invoked
|
60
|
+
|
61
|
+
#### GET (a collection)
|
62
|
+
|
63
|
+
```ruby
|
64
|
+
client.get :document # fetching a list of documents
|
65
|
+
client.get :contact # fetching a list of contacts
|
66
|
+
|
67
|
+
# adding a query
|
68
|
+
documents = client.get :document { |req| req.params['document_number'] = "1000" }
|
69
|
+
documents = client.get :document { |req| req.params['date__lt'] = "2020-01-30" }
|
70
|
+
```
|
71
|
+
|
72
|
+
#### Traversal access
|
73
|
+
When you want to retrieve a collection of resources (e.g. invoices, cliet contacts..) which size is larger than that a single response can contain, you need to make a consecutive chain of calls, following the `next` link provided by the prior response.
|
74
|
+
|
75
|
+
To traverse multiple pages following `next` links, below methods such as `#each_page`, `#each_resource`, `#find_resource` are available for convenience.
|
76
|
+
|
77
|
+
WARNING: this could potentially invoke an unexpected number of API calls. Consider limiting your possibile accesses, otherwise you might exceed the maximum allowed number of requests (see [throttling](https://app.makeleaps.com/api/docs/) in the API document)
|
78
|
+
|
79
|
+
Current default limit is set as 100 pages / each method, and the rate limit is set as 0.1sec / request so that it won't cause accidental traffic to the API.
|
80
|
+
|
81
|
+
```ruby
|
82
|
+
# visiting all pages (following `next` links provided by API)
|
83
|
+
# (requests are limited at maximum rate of 0.1sec per each)
|
84
|
+
total_count = 0
|
85
|
+
client.each_page :document do |documents|
|
86
|
+
total_count += documents.count
|
87
|
+
end
|
88
|
+
|
89
|
+
# query strings can be added with `params` option
|
90
|
+
# this will invoke
|
91
|
+
# GET 'https://api.makeleaps.com/api/partner/<partner_id>/document/?document_type=invoice&&date__gte=2019-01-01&&date__lt=2019-04-01'
|
92
|
+
# and follows `next` url until it reaches to the last page OR the maximum limit page (default 100)
|
93
|
+
total_count = 0
|
94
|
+
client.each_page :document, params: {document_type: :invoice, date__gte: '2019-01-01', date__lt: '2019-04-01'} do |documents|
|
95
|
+
total_count += documents.count
|
96
|
+
end
|
97
|
+
|
98
|
+
# each resources (that each page contains) can also be accessed via #each_resource
|
99
|
+
# (interface are consistent with #each_page)
|
100
|
+
client.each_resouce :document, params: {document_type: :invoice, date__gte: '2019-01-01', date__lt: '2019-04-01'} do |invoice|
|
101
|
+
puts invoice['display_name']
|
102
|
+
end
|
103
|
+
|
104
|
+
# find a resource (out of all the pages)
|
105
|
+
# visits next_urls one after another. terminates when it find the first resource (with whivh the given block evaluates as true), or when it reaches to one of either the last page OR the max page (default 100)
|
106
|
+
# returns the detected resource or nil (when not found)
|
107
|
+
client.find_resource(:document), params: {document_type: :invoice} do |document|
|
108
|
+
document['title'].match? /URGENT/
|
109
|
+
end
|
110
|
+
|
111
|
+
# find a resource (within a response)
|
112
|
+
documents = client.get :document
|
113
|
+
document.find_resource do |document|
|
114
|
+
document['document_number'].to_i >= 123 && document['note'].match? /IMPORTANT/
|
115
|
+
end
|
116
|
+
```
|
117
|
+
|
118
|
+
#### POST/PATCH/PUT/DELETE
|
119
|
+
|
120
|
+
Read the manual carefully before sending a request- it seems API is still beta version, so it might give an unexpected effect on your data when misused. The wrapper gem does not check the validity of the request parameters/payloads.
|
121
|
+
|
122
|
+
```ruby
|
123
|
+
client.post :item, <mid> { |req| req.body = new_item.to_json }
|
124
|
+
|
125
|
+
client.patch(:document, <mid>) { |req| req.body = {autocalculate: true, lineitems: updated_items}.to_json }
|
126
|
+
|
127
|
+
client.delete :contact, <mid>
|
128
|
+
```
|
129
|
+
|
130
|
+
## Development
|
131
|
+
|
132
|
+
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.
|
133
|
+
|
134
|
+
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).
|
135
|
+
|
136
|
+
## Contributing
|
137
|
+
|
138
|
+
Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/makeleaps-ruby.
|
139
|
+
|
140
|
+
## License
|
141
|
+
|
142
|
+
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
|
data/Rakefile
ADDED
data/bin/console
ADDED
@@ -0,0 +1,14 @@
|
|
1
|
+
#!/usr/bin/env ruby
|
2
|
+
|
3
|
+
require "bundler/setup"
|
4
|
+
require "makeleaps"
|
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(__FILE__)
|
data/bin/setup
ADDED
@@ -0,0 +1,29 @@
|
|
1
|
+
require_relative 'request'
|
2
|
+
require_relative 'response'
|
3
|
+
require 'forwardable'
|
4
|
+
|
5
|
+
module Makeleaps
|
6
|
+
class Client
|
7
|
+
extend Forwardable
|
8
|
+
|
9
|
+
attr_accessor :partner_mid
|
10
|
+
attr_reader :request
|
11
|
+
def_delegators :@request, :get, :post, :put, :patch, :delete, :options
|
12
|
+
def_delegators :@request, :each_page, :each_resource, :find_resource, :set_partner!
|
13
|
+
def_delegators :@request, :connection
|
14
|
+
|
15
|
+
def initialize(username, password)
|
16
|
+
@auth_request = Makeleaps::Request::BasicAuth.new(username, password)
|
17
|
+
end
|
18
|
+
|
19
|
+
def connect!
|
20
|
+
@token_store ||= @auth_request.authenticate!
|
21
|
+
@request = Makeleaps::Request::Generic.new(@token_store.access_token)
|
22
|
+
end
|
23
|
+
|
24
|
+
def disconnect!
|
25
|
+
@auth_request.revoke!(@token_store.access_token)
|
26
|
+
@token_store = nil
|
27
|
+
end
|
28
|
+
end
|
29
|
+
end
|
@@ -0,0 +1,23 @@
|
|
1
|
+
module Makeleaps
|
2
|
+
class Error < StandardError; end
|
3
|
+
|
4
|
+
class APIError < Error
|
5
|
+
attr_accessor :status
|
6
|
+
|
7
|
+
def initialize(message, status=nil)
|
8
|
+
super(message)
|
9
|
+
@status = status
|
10
|
+
end
|
11
|
+
end
|
12
|
+
|
13
|
+
module ErrorHandler
|
14
|
+
def handle_api_response(success: 200, &block)
|
15
|
+
response = block.call
|
16
|
+
return response if [success].flatten.include? response.status
|
17
|
+
|
18
|
+
message = response.respond_to?(:resource) ? response.resource : response.inspect
|
19
|
+
# 'Makeleaps API error'
|
20
|
+
raise Makeleaps::APIError.new(message, response.status)
|
21
|
+
end
|
22
|
+
end
|
23
|
+
end
|
@@ -0,0 +1,15 @@
|
|
1
|
+
module Makeleaps
|
2
|
+
module Request
|
3
|
+
class Base
|
4
|
+
ENDPOINT = 'https://api.makeleaps.com/'
|
5
|
+
|
6
|
+
attr_reader :connection
|
7
|
+
def initialize(&block)
|
8
|
+
@connection = Faraday.new(url: ENDPOINT, headers: {'Accept' => 'application/json', 'Content-Type': 'application/json'}) do |conn|
|
9
|
+
conn.adapter Faraday.default_adapter
|
10
|
+
block.call(conn) if block_given?
|
11
|
+
end
|
12
|
+
end
|
13
|
+
end
|
14
|
+
end
|
15
|
+
end
|
@@ -0,0 +1,35 @@
|
|
1
|
+
require_relative 'base'
|
2
|
+
|
3
|
+
module Makeleaps
|
4
|
+
module Request
|
5
|
+
class BasicAuth < Base
|
6
|
+
include ErrorHandler
|
7
|
+
|
8
|
+
AUTH_ENDPOINT = 'user/oauth2/token/'
|
9
|
+
REVOCATKON_ENDPOINT = 'user/oauth2/revoke-token/'
|
10
|
+
|
11
|
+
def initialize(username, password)
|
12
|
+
super() do |conn|
|
13
|
+
conn.set_basic_auth(username, password)
|
14
|
+
end
|
15
|
+
end
|
16
|
+
|
17
|
+
def authenticate!
|
18
|
+
response = handle_api_response do
|
19
|
+
connection.post(AUTH_ENDPOINT) do |req|
|
20
|
+
req.headers['Content-Type'] = 'application/x-www-form-urlencoded'
|
21
|
+
data = { grant_type: 'client_credentials' }
|
22
|
+
req.body = URI.encode_www_form(data)
|
23
|
+
end
|
24
|
+
end
|
25
|
+
Makeleaps::Response::TokenStore.new response
|
26
|
+
end
|
27
|
+
|
28
|
+
def revoke!(token)
|
29
|
+
handle_api_response do
|
30
|
+
connection.post(REVOCATKON_ENDPOINT) { |req| req.params['token'] = token }
|
31
|
+
end
|
32
|
+
end
|
33
|
+
end
|
34
|
+
end
|
35
|
+
end
|
@@ -0,0 +1,90 @@
|
|
1
|
+
require_relative 'base'
|
2
|
+
require_relative 'request_handler'
|
3
|
+
require_relative 'url_manager'
|
4
|
+
|
5
|
+
module Makeleaps
|
6
|
+
module Request
|
7
|
+
class Generic < Base
|
8
|
+
attr_reader :handler, :url_manager
|
9
|
+
|
10
|
+
def initialize(access_token)
|
11
|
+
super() do |conn|
|
12
|
+
conn.authorization :Bearer, access_token
|
13
|
+
end
|
14
|
+
@handler = Makeleaps::Request::RequestHandler.new(connection)
|
15
|
+
@url_manager = Makeleaps::Request::URLManager.new
|
16
|
+
end
|
17
|
+
|
18
|
+
def set_partner!(name: )
|
19
|
+
url = find_partner_by(name: name)['url']
|
20
|
+
partner_mid = url.split('/').last
|
21
|
+
url_manager.set_partner!(partner_mid)
|
22
|
+
self
|
23
|
+
end
|
24
|
+
|
25
|
+
def find_partner_by(name: )
|
26
|
+
partners = get(:partner)
|
27
|
+
partners.find_resource { |partner| partner['name'] == name }
|
28
|
+
end
|
29
|
+
|
30
|
+
# set max_pages to change the maximum number of retrievable pages
|
31
|
+
# WARNING: this might invoke too many API accesses.
|
32
|
+
def each_page(start_page, *args, params: nil, max_pages: nil, &block)
|
33
|
+
next_url = start_page
|
34
|
+
max_pages = max_pages || 100 # TODO: let default value be customizeable using config
|
35
|
+
|
36
|
+
max_pages.times do
|
37
|
+
response = get(next_url, *args) { |req|
|
38
|
+
req.params.merge!(params) unless params.nil?
|
39
|
+
}
|
40
|
+
block.call(response)
|
41
|
+
next_url = response.next
|
42
|
+
break unless next_url
|
43
|
+
sleep 0.1 # TODO: throttling parameter can be adjusted individually
|
44
|
+
end
|
45
|
+
end
|
46
|
+
|
47
|
+
# set max_pages to change the maximum number of retrievable pages
|
48
|
+
# WARNING: this might invoke too many API accesses.
|
49
|
+
def each_resource(start_page, *args, params: nil, max_pages: nil, &block)
|
50
|
+
each_page(start_page, *args, params: params, max_pages: max_pages) do |page|
|
51
|
+
page.each_resource do |resource|
|
52
|
+
block.call(resource)
|
53
|
+
end
|
54
|
+
end
|
55
|
+
end
|
56
|
+
|
57
|
+
def find_resource(start_page, *args, params: nil, max_pages: nil, &block)
|
58
|
+
each_page(start_page, params: params, max_pages: max_pages) do |page|
|
59
|
+
resource = page.find_resource(*args, &block)
|
60
|
+
return resource if resource
|
61
|
+
end
|
62
|
+
nil
|
63
|
+
end
|
64
|
+
|
65
|
+
def get(resource_or_url, mid=nil, &block)
|
66
|
+
handler.get url_manager.build_url_for(resource_or_url, mid), &block
|
67
|
+
end
|
68
|
+
|
69
|
+
def post(resource_or_url, mid=nil, &block)
|
70
|
+
handler.post url_manager.build_url_for(resource_or_url, mid), &block
|
71
|
+
end
|
72
|
+
|
73
|
+
def put(resource_or_url, mid=nil, &block)
|
74
|
+
handler.put url_manager.build_url_for(resource_or_url, mid), &block
|
75
|
+
end
|
76
|
+
|
77
|
+
def patch(resource_or_url, mid=nil, &block)
|
78
|
+
handler.patch url_manager.build_url_for(resource_or_url, mid), &block
|
79
|
+
end
|
80
|
+
|
81
|
+
def delete(resource_or_url, mid=nil, &block)
|
82
|
+
handler.delete url_manager.build_url_for(resource_or_url, mid), &block
|
83
|
+
end
|
84
|
+
|
85
|
+
def options(resource_or_url, mid=nil, &block)
|
86
|
+
handler.options url_manager.build_url_for(resource_or_url, mid), &block
|
87
|
+
end
|
88
|
+
end
|
89
|
+
end
|
90
|
+
end
|
@@ -0,0 +1,54 @@
|
|
1
|
+
module Makeleaps
|
2
|
+
module Request
|
3
|
+
class RequestHandler
|
4
|
+
include ErrorHandler
|
5
|
+
|
6
|
+
attr_reader :connection
|
7
|
+
def initialize(connection)
|
8
|
+
@connection = connection
|
9
|
+
end
|
10
|
+
|
11
|
+
def get(*args, &block)
|
12
|
+
response = handle_api_response(success: 200) do
|
13
|
+
connection.get(*args, &block)
|
14
|
+
end
|
15
|
+
Makeleaps::Response::Wrapper.new response
|
16
|
+
end
|
17
|
+
|
18
|
+
def post(*args, &block)
|
19
|
+
response = handle_api_response(success: 201) do
|
20
|
+
connection.post(*args, &block)
|
21
|
+
end
|
22
|
+
Makeleaps::Response::Wrapper.new response
|
23
|
+
end
|
24
|
+
|
25
|
+
def patch(*args, &block)
|
26
|
+
response = handle_api_response(success: 200) do
|
27
|
+
connection.patch(*args, &block)
|
28
|
+
end
|
29
|
+
Makeleaps::Response::Wrapper.new response
|
30
|
+
end
|
31
|
+
|
32
|
+
def put(*args, &block)
|
33
|
+
response = handle_api_response(success: 200) do
|
34
|
+
connection.put(*args, &block)
|
35
|
+
end
|
36
|
+
Makeleaps::Response::Wrapper.new response
|
37
|
+
end
|
38
|
+
|
39
|
+
def delete(*args, &block)
|
40
|
+
response = handle_api_response(success: 204) do
|
41
|
+
connection.delete(*args, &block)
|
42
|
+
end
|
43
|
+
Makeleaps::Response::Wrapper.new response
|
44
|
+
end
|
45
|
+
|
46
|
+
def options(url, &block)
|
47
|
+
response = handle_api_response(success: 200) do
|
48
|
+
connection.run_request(:options, url, nil, nil, &block)
|
49
|
+
end
|
50
|
+
Makeleaps::Response::Wrapper.new response
|
51
|
+
end
|
52
|
+
end
|
53
|
+
end
|
54
|
+
end
|
@@ -0,0 +1,37 @@
|
|
1
|
+
module Makeleaps
|
2
|
+
module Request
|
3
|
+
class URLManager
|
4
|
+
API_ENDPOINT_BASE = 'https://api.makeleaps.com/api'
|
5
|
+
GENERIC_ENDPOINT = "#{API_ENDPOINT_BASE}/partner"
|
6
|
+
CURRENCY_ENDPOINT = "#{API_ENDPOINT_BASE}/currency"
|
7
|
+
|
8
|
+
attr_reader :partner_mid
|
9
|
+
|
10
|
+
def set_partner!(partner_mid)
|
11
|
+
@partner_mid = partner_mid
|
12
|
+
end
|
13
|
+
|
14
|
+
def build_url_for(resource_or_url, mid=nil)
|
15
|
+
case resource_or_url
|
16
|
+
when String
|
17
|
+
resource_or_url # assume its a url
|
18
|
+
when :partner
|
19
|
+
compose_url GENERIC_ENDPOINT, mid
|
20
|
+
when :currency
|
21
|
+
compose_url CURRENCY_ENDPOINT
|
22
|
+
when :client_contact
|
23
|
+
# TODO: ensure that @partner_mid exists
|
24
|
+
compose_url GENERIC_ENDPOINT, @partner_mid, :client, mid, :contact
|
25
|
+
else
|
26
|
+
# TODO: ensure that @partner_mid exists
|
27
|
+
compose_url GENERIC_ENDPOINT, @partner_mid, resource_or_url, mid
|
28
|
+
end
|
29
|
+
end
|
30
|
+
|
31
|
+
private
|
32
|
+
def compose_url(*parts)
|
33
|
+
[*parts, ''].compact.join('/')
|
34
|
+
end
|
35
|
+
end
|
36
|
+
end
|
37
|
+
end
|
@@ -0,0 +1,38 @@
|
|
1
|
+
require 'json'
|
2
|
+
|
3
|
+
module Makeleaps
|
4
|
+
module Response
|
5
|
+
class TokenStore
|
6
|
+
attr_reader :response, :body
|
7
|
+
|
8
|
+
def initialize(response)
|
9
|
+
@response = response
|
10
|
+
@body = JSON.parse(response.body)
|
11
|
+
rescue JSON::JSONError
|
12
|
+
@body = nil
|
13
|
+
end
|
14
|
+
|
15
|
+
def access_token
|
16
|
+
@access_token ||= body['access_token']
|
17
|
+
end
|
18
|
+
|
19
|
+
def valid?
|
20
|
+
response && response.status == 200 && !expired?
|
21
|
+
end
|
22
|
+
|
23
|
+
private
|
24
|
+
|
25
|
+
def expired?
|
26
|
+
Time.now >= requested_at + expiration_period
|
27
|
+
end
|
28
|
+
|
29
|
+
def requested_at
|
30
|
+
Time.parse response.headers['date']
|
31
|
+
end
|
32
|
+
|
33
|
+
def expiration_period
|
34
|
+
body['expires_in']
|
35
|
+
end
|
36
|
+
end
|
37
|
+
end
|
38
|
+
end
|
@@ -0,0 +1,14 @@
|
|
1
|
+
module Makeleaps
|
2
|
+
module Response
|
3
|
+
module HashAccessDelegator
|
4
|
+
def delegate_hash_access(hash_name, *method_names)
|
5
|
+
method_names.each do |method|
|
6
|
+
define_method(method.to_sym) do
|
7
|
+
base_hash = instance_eval(hash_name)
|
8
|
+
base_hash[method.to_s]
|
9
|
+
end
|
10
|
+
end
|
11
|
+
end
|
12
|
+
end
|
13
|
+
end
|
14
|
+
end
|
@@ -0,0 +1,15 @@
|
|
1
|
+
require_relative 'hash_access_delegator'
|
2
|
+
|
3
|
+
module Makeleaps
|
4
|
+
module Response
|
5
|
+
class MetaInformation
|
6
|
+
extend HashAccessDelegator
|
7
|
+
delegate_hash_access '@meta_information', :next, :prev, :page, :count, :status
|
8
|
+
attr_accessor :meta_information
|
9
|
+
|
10
|
+
def initialize(meta_information)
|
11
|
+
@meta_information = meta_information
|
12
|
+
end
|
13
|
+
end
|
14
|
+
end
|
15
|
+
end
|
@@ -0,0 +1,30 @@
|
|
1
|
+
module Makeleaps
|
2
|
+
module Response
|
3
|
+
class Resource
|
4
|
+
attr_accessor :content
|
5
|
+
|
6
|
+
def initialize(content)
|
7
|
+
@content = content
|
8
|
+
end
|
9
|
+
|
10
|
+
# ensure data are encupslated in an array (for interface consistency)
|
11
|
+
def content_as_array
|
12
|
+
[content].flatten
|
13
|
+
end
|
14
|
+
|
15
|
+
def each_resource(&block)
|
16
|
+
if block_given?
|
17
|
+
content_as_array.each do |resource|
|
18
|
+
block.call(resource)
|
19
|
+
end
|
20
|
+
else
|
21
|
+
content_as_array.to_enum
|
22
|
+
end
|
23
|
+
end
|
24
|
+
|
25
|
+
def find_resource(*args, &block)
|
26
|
+
content_as_array.find(*args, &block)
|
27
|
+
end
|
28
|
+
end
|
29
|
+
end
|
30
|
+
end
|
@@ -0,0 +1,27 @@
|
|
1
|
+
require 'forwardable'
|
2
|
+
require_relative 'meta_information'
|
3
|
+
require_relative 'resource'
|
4
|
+
|
5
|
+
module Makeleaps
|
6
|
+
module Response
|
7
|
+
class Wrapper
|
8
|
+
extend Forwardable
|
9
|
+
|
10
|
+
attr_reader :body, :status, :meta_information, :resource
|
11
|
+
def_delegators :@meta_information, :next, :prev, :page, :count, :status
|
12
|
+
def_delegators :@resource, :each_resource, :find_resource
|
13
|
+
|
14
|
+
def initialize(raw_response)
|
15
|
+
@status = raw_response.status
|
16
|
+
begin
|
17
|
+
@body = JSON.parse(raw_response.body)
|
18
|
+
rescue JSON::JSONError
|
19
|
+
# TODO: to raise an original error?
|
20
|
+
@body = {}
|
21
|
+
end
|
22
|
+
@meta_information = MetaInformation.new @body['meta']
|
23
|
+
@resource = Resource.new @body['response']
|
24
|
+
end
|
25
|
+
end
|
26
|
+
end
|
27
|
+
end
|
data/lib/makeleaps.rb
ADDED
@@ -0,0 +1,44 @@
|
|
1
|
+
|
2
|
+
lib = File.expand_path("../lib", __FILE__)
|
3
|
+
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
4
|
+
require "makeleaps/version"
|
5
|
+
|
6
|
+
Gem::Specification.new do |spec|
|
7
|
+
spec.name = "v-makeleaps-ruby"
|
8
|
+
spec.version = Makeleaps::VERSION
|
9
|
+
spec.authors = ["Koji Onishi", "Hieu Nguyen"]
|
10
|
+
spec.email = ["nguyen.trung.hieu@vareal.vn"]
|
11
|
+
|
12
|
+
spec.summary = 'A Ruby-based, thin wrapper gem for Makeleaps API'
|
13
|
+
spec.description = 'A third-party (unofficial) Makeleaps API client. Provides you a simple and intuitive access to Makeleaps API'
|
14
|
+
spec.homepage = 'https://github.com/vareal/makeleaps-ruby'
|
15
|
+
spec.license = 'MIT'
|
16
|
+
spec.required_ruby_version = '>= 2.3.0'
|
17
|
+
|
18
|
+
if spec.respond_to?(:metadata)
|
19
|
+
spec.metadata["homepage_uri"] = 'https://github.com/vareal/makeleaps-ruby'
|
20
|
+
spec.metadata["source_code_uri"] = 'https://github.com/vareal/makeleaps-ruby'
|
21
|
+
# spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
|
22
|
+
end
|
23
|
+
|
24
|
+
# Specify which files should be added to the gem when it is released.
|
25
|
+
# The `git ls-files -z` loads the files in the RubyGem that have been added into git.
|
26
|
+
spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
|
27
|
+
`git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
|
28
|
+
end
|
29
|
+
spec.bindir = "exe"
|
30
|
+
spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
|
31
|
+
spec.require_paths = ["lib"]
|
32
|
+
|
33
|
+
spec.add_dependency 'faraday', '1.10'
|
34
|
+
|
35
|
+
spec.add_development_dependency 'bundler', '~> 2.0'
|
36
|
+
spec.add_development_dependency 'rake', '~> 10.0'
|
37
|
+
spec.add_development_dependency 'rspec', '~> 3.0'
|
38
|
+
spec.add_development_dependency 'vcr', '>= 5.0'
|
39
|
+
spec.add_development_dependency 'webmock'
|
40
|
+
spec.add_development_dependency "hashdiff", ">= 1.0.0.beta1", "< 2.0.0"
|
41
|
+
|
42
|
+
spec.add_development_dependency 'pry'
|
43
|
+
spec.add_development_dependency 'pry-doc'
|
44
|
+
end
|
metadata
ADDED
@@ -0,0 +1,205 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: v-makeleaps-ruby
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.1.6
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- Koji Onishi
|
8
|
+
- Hieu Nguyen
|
9
|
+
autorequire:
|
10
|
+
bindir: exe
|
11
|
+
cert_chain: []
|
12
|
+
date: 2022-05-13 00:00:00.000000000 Z
|
13
|
+
dependencies:
|
14
|
+
- !ruby/object:Gem::Dependency
|
15
|
+
name: faraday
|
16
|
+
requirement: !ruby/object:Gem::Requirement
|
17
|
+
requirements:
|
18
|
+
- - '='
|
19
|
+
- !ruby/object:Gem::Version
|
20
|
+
version: '1.10'
|
21
|
+
type: :runtime
|
22
|
+
prerelease: false
|
23
|
+
version_requirements: !ruby/object:Gem::Requirement
|
24
|
+
requirements:
|
25
|
+
- - '='
|
26
|
+
- !ruby/object:Gem::Version
|
27
|
+
version: '1.10'
|
28
|
+
- !ruby/object:Gem::Dependency
|
29
|
+
name: bundler
|
30
|
+
requirement: !ruby/object:Gem::Requirement
|
31
|
+
requirements:
|
32
|
+
- - "~>"
|
33
|
+
- !ruby/object:Gem::Version
|
34
|
+
version: '2.0'
|
35
|
+
type: :development
|
36
|
+
prerelease: false
|
37
|
+
version_requirements: !ruby/object:Gem::Requirement
|
38
|
+
requirements:
|
39
|
+
- - "~>"
|
40
|
+
- !ruby/object:Gem::Version
|
41
|
+
version: '2.0'
|
42
|
+
- !ruby/object:Gem::Dependency
|
43
|
+
name: rake
|
44
|
+
requirement: !ruby/object:Gem::Requirement
|
45
|
+
requirements:
|
46
|
+
- - "~>"
|
47
|
+
- !ruby/object:Gem::Version
|
48
|
+
version: '10.0'
|
49
|
+
type: :development
|
50
|
+
prerelease: false
|
51
|
+
version_requirements: !ruby/object:Gem::Requirement
|
52
|
+
requirements:
|
53
|
+
- - "~>"
|
54
|
+
- !ruby/object:Gem::Version
|
55
|
+
version: '10.0'
|
56
|
+
- !ruby/object:Gem::Dependency
|
57
|
+
name: rspec
|
58
|
+
requirement: !ruby/object:Gem::Requirement
|
59
|
+
requirements:
|
60
|
+
- - "~>"
|
61
|
+
- !ruby/object:Gem::Version
|
62
|
+
version: '3.0'
|
63
|
+
type: :development
|
64
|
+
prerelease: false
|
65
|
+
version_requirements: !ruby/object:Gem::Requirement
|
66
|
+
requirements:
|
67
|
+
- - "~>"
|
68
|
+
- !ruby/object:Gem::Version
|
69
|
+
version: '3.0'
|
70
|
+
- !ruby/object:Gem::Dependency
|
71
|
+
name: vcr
|
72
|
+
requirement: !ruby/object:Gem::Requirement
|
73
|
+
requirements:
|
74
|
+
- - ">="
|
75
|
+
- !ruby/object:Gem::Version
|
76
|
+
version: '5.0'
|
77
|
+
type: :development
|
78
|
+
prerelease: false
|
79
|
+
version_requirements: !ruby/object:Gem::Requirement
|
80
|
+
requirements:
|
81
|
+
- - ">="
|
82
|
+
- !ruby/object:Gem::Version
|
83
|
+
version: '5.0'
|
84
|
+
- !ruby/object:Gem::Dependency
|
85
|
+
name: webmock
|
86
|
+
requirement: !ruby/object:Gem::Requirement
|
87
|
+
requirements:
|
88
|
+
- - ">="
|
89
|
+
- !ruby/object:Gem::Version
|
90
|
+
version: '0'
|
91
|
+
type: :development
|
92
|
+
prerelease: false
|
93
|
+
version_requirements: !ruby/object:Gem::Requirement
|
94
|
+
requirements:
|
95
|
+
- - ">="
|
96
|
+
- !ruby/object:Gem::Version
|
97
|
+
version: '0'
|
98
|
+
- !ruby/object:Gem::Dependency
|
99
|
+
name: hashdiff
|
100
|
+
requirement: !ruby/object:Gem::Requirement
|
101
|
+
requirements:
|
102
|
+
- - ">="
|
103
|
+
- !ruby/object:Gem::Version
|
104
|
+
version: 1.0.0.beta1
|
105
|
+
- - "<"
|
106
|
+
- !ruby/object:Gem::Version
|
107
|
+
version: 2.0.0
|
108
|
+
type: :development
|
109
|
+
prerelease: false
|
110
|
+
version_requirements: !ruby/object:Gem::Requirement
|
111
|
+
requirements:
|
112
|
+
- - ">="
|
113
|
+
- !ruby/object:Gem::Version
|
114
|
+
version: 1.0.0.beta1
|
115
|
+
- - "<"
|
116
|
+
- !ruby/object:Gem::Version
|
117
|
+
version: 2.0.0
|
118
|
+
- !ruby/object:Gem::Dependency
|
119
|
+
name: pry
|
120
|
+
requirement: !ruby/object:Gem::Requirement
|
121
|
+
requirements:
|
122
|
+
- - ">="
|
123
|
+
- !ruby/object:Gem::Version
|
124
|
+
version: '0'
|
125
|
+
type: :development
|
126
|
+
prerelease: false
|
127
|
+
version_requirements: !ruby/object:Gem::Requirement
|
128
|
+
requirements:
|
129
|
+
- - ">="
|
130
|
+
- !ruby/object:Gem::Version
|
131
|
+
version: '0'
|
132
|
+
- !ruby/object:Gem::Dependency
|
133
|
+
name: pry-doc
|
134
|
+
requirement: !ruby/object:Gem::Requirement
|
135
|
+
requirements:
|
136
|
+
- - ">="
|
137
|
+
- !ruby/object:Gem::Version
|
138
|
+
version: '0'
|
139
|
+
type: :development
|
140
|
+
prerelease: false
|
141
|
+
version_requirements: !ruby/object:Gem::Requirement
|
142
|
+
requirements:
|
143
|
+
- - ">="
|
144
|
+
- !ruby/object:Gem::Version
|
145
|
+
version: '0'
|
146
|
+
description: A third-party (unofficial) Makeleaps API client. Provides you a simple
|
147
|
+
and intuitive access to Makeleaps API
|
148
|
+
email:
|
149
|
+
- nguyen.trung.hieu@vareal.vn
|
150
|
+
executables: []
|
151
|
+
extensions: []
|
152
|
+
extra_rdoc_files: []
|
153
|
+
files:
|
154
|
+
- ".gitignore"
|
155
|
+
- ".rspec"
|
156
|
+
- ".travis.yml"
|
157
|
+
- Gemfile
|
158
|
+
- LICENSE.txt
|
159
|
+
- README.md
|
160
|
+
- Rakefile
|
161
|
+
- bin/console
|
162
|
+
- bin/setup
|
163
|
+
- lib/makeleaps.rb
|
164
|
+
- lib/makeleaps/client.rb
|
165
|
+
- lib/makeleaps/errors.rb
|
166
|
+
- lib/makeleaps/request.rb
|
167
|
+
- lib/makeleaps/request/base.rb
|
168
|
+
- lib/makeleaps/request/basic_auth.rb
|
169
|
+
- lib/makeleaps/request/generic.rb
|
170
|
+
- lib/makeleaps/request/request_handler.rb
|
171
|
+
- lib/makeleaps/request/url_manager.rb
|
172
|
+
- lib/makeleaps/response.rb
|
173
|
+
- lib/makeleaps/response/access_token.rb
|
174
|
+
- lib/makeleaps/response/hash_access_delegator.rb
|
175
|
+
- lib/makeleaps/response/meta_information.rb
|
176
|
+
- lib/makeleaps/response/resource.rb
|
177
|
+
- lib/makeleaps/response/wrapper.rb
|
178
|
+
- lib/makeleaps/version.rb
|
179
|
+
- makeleaps-ruby.gemspec
|
180
|
+
homepage: https://github.com/vareal/makeleaps-ruby
|
181
|
+
licenses:
|
182
|
+
- MIT
|
183
|
+
metadata:
|
184
|
+
homepage_uri: https://github.com/vareal/makeleaps-ruby
|
185
|
+
source_code_uri: https://github.com/vareal/makeleaps-ruby
|
186
|
+
post_install_message:
|
187
|
+
rdoc_options: []
|
188
|
+
require_paths:
|
189
|
+
- lib
|
190
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
191
|
+
requirements:
|
192
|
+
- - ">="
|
193
|
+
- !ruby/object:Gem::Version
|
194
|
+
version: 2.3.0
|
195
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
196
|
+
requirements:
|
197
|
+
- - ">="
|
198
|
+
- !ruby/object:Gem::Version
|
199
|
+
version: '0'
|
200
|
+
requirements: []
|
201
|
+
rubygems_version: 3.3.7
|
202
|
+
signing_key:
|
203
|
+
specification_version: 4
|
204
|
+
summary: A Ruby-based, thin wrapper gem for Makeleaps API
|
205
|
+
test_files: []
|