fera-api 0.1.3 → 0.2.3

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 5f5fcef6bfad094e9853066b852f6992540e9321015531350e7bc6b02b94d71e
4
- data.tar.gz: eff0b267a65ad12bbb8bb42c24c42409224774e1e45a53005e1fecf0b0be5fa2
3
+ metadata.gz: a57edbe52b6971a3d74201e5313ebe1f06166d2efa8f0be1013d3f4809c64c69
4
+ data.tar.gz: 5d435cfed0ec28813cb6501c97f7919d0bf3197d946cbd9a4dd08687b30dc0d7
5
5
  SHA512:
6
- metadata.gz: d0e8f790bdcced7f48af3b8d0f2e59773e3a69ec429b584068ad5d769cdb39835b87c4301f012ed3da06af8b9ffecb1e21e5ce69e94265472473be543996bb46
7
- data.tar.gz: 49380fcbb2c591cb0c7c7c730e38bde23a17f3ce1ab59af08c3b6e340700932bc5219af9c11a0bc55e92201ccba8dcd9ada8ee053edae6f3a0faf656967434fe
6
+ metadata.gz: f7951d6031da2542091c04c23092bfb89d4b60c2666c00883a067aa5a25b07c4ea9cf1f44695ebc7a55706621fc55f992d4eec8b39b90b29f3822b447dbbd822
7
+ data.tar.gz: c9ab5cffab575258f506eb6ffec0fed26c2fa1e4c5e04f22e77b2849153f62f97f7a73f18c522a7788bb39f586cebf78c9f6599ecc51e6f33a54817e24cf299a
data/Gemfile CHANGED
@@ -6,12 +6,10 @@ source "https://rubygems.org"
6
6
  gemspec
7
7
 
8
8
  group :development, :test do
9
- gem "pry"
10
- gem "pry-byebug"
11
9
  gem "pry-rails"
12
10
  gem "pry-remote"
13
11
  gem "pry-rescue"
14
- gem "pry-stack_explorer"
15
- gem "rubocop"
16
- gem "rubocop-rspec"
12
+ gem "rubocop", "~> 1.35"
13
+ gem "rubocop-rspec", "~> 2.12"
14
+ gem "spellr", "~> 0.11"
17
15
  end
data/Gemfile.lock CHANGED
@@ -1,7 +1,7 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- fera-api (0.1.3)
4
+ fera-api (0.2.3)
5
5
  activemodel (>= 4)
6
6
  activeresource (>= 6)
7
7
  activesupport (>= 4.0)
@@ -11,8 +11,8 @@ PATH
11
11
  GEM
12
12
  remote: https://rubygems.org/
13
13
  specs:
14
- activemodel (7.0.3.1)
15
- activesupport (= 7.0.3.1)
14
+ activemodel (7.0.4)
15
+ activesupport (= 7.0.4)
16
16
  activemodel-serializers-xml (1.0.2)
17
17
  activemodel (> 5.x)
18
18
  activesupport (> 5.x)
@@ -21,7 +21,7 @@ GEM
21
21
  activemodel (>= 6.0)
22
22
  activemodel-serializers-xml (~> 1.0)
23
23
  activesupport (>= 6.0)
24
- activesupport (7.0.3.1)
24
+ activesupport (7.0.4)
25
25
  concurrent-ruby (~> 1.0, >= 1.0.2)
26
26
  i18n (>= 1.6, < 2)
27
27
  minitest (>= 5.1)
@@ -30,7 +30,7 @@ GEM
30
30
  public_suffix (>= 2.0.2, < 5.0)
31
31
  aes_key_wrap (1.1.0)
32
32
  ast (2.4.2)
33
- bindata (2.4.10)
33
+ bindata (2.4.14)
34
34
  binding_of_caller (1.0.0)
35
35
  debug_inspector (>= 0.0.1)
36
36
  builder (3.2.4)
@@ -41,17 +41,25 @@ GEM
41
41
  rexml
42
42
  debug_inspector (1.1.0)
43
43
  diff-lcs (1.5.0)
44
+ faraday (2.6.0)
45
+ faraday-net_http (>= 2.0, < 3.1)
46
+ ruby2_keywords (>= 0.0.4)
47
+ faraday-follow_redirects (0.3.0)
48
+ faraday (>= 1, < 3)
49
+ faraday-net_http (3.0.1)
50
+ fast_ignore (0.17.4)
44
51
  hashdiff (1.0.1)
45
- httpclient (2.8.3)
46
52
  i18n (1.12.0)
47
53
  concurrent-ruby (~> 1.0)
48
54
  interception (0.5)
55
+ jaro_winkler (1.5.4)
49
56
  json (2.6.2)
50
- json-jwt (1.15.3)
57
+ json-jwt (1.16.1)
51
58
  activesupport (>= 4.2)
52
59
  aes_key_wrap
53
60
  bindata
54
- httpclient
61
+ faraday (~> 2.0)
62
+ faraday-follow_redirects
55
63
  method_source (1.0.0)
56
64
  minitest (5.16.3)
57
65
  parallel (1.22.1)
@@ -92,7 +100,7 @@ GEM
92
100
  diff-lcs (>= 1.2.0, < 2.0)
93
101
  rspec-support (~> 3.11.0)
94
102
  rspec-support (3.11.0)
95
- rubocop (1.35.0)
103
+ rubocop (1.35.1)
96
104
  json (~> 2.3)
97
105
  parallel (~> 1.10)
98
106
  parser (>= 3.1.2.1)
@@ -104,22 +112,29 @@ GEM
104
112
  unicode-display_width (>= 1.4.0, < 3.0)
105
113
  rubocop-ast (1.21.0)
106
114
  parser (>= 3.1.1.0)
107
- rubocop-rspec (2.12.1)
108
- rubocop (~> 1.31)
115
+ rubocop-rspec (2.13.1)
116
+ rubocop (~> 1.33)
109
117
  ruby-progressbar (1.11.0)
118
+ ruby2_keywords (0.0.5)
110
119
  slop (3.6.0)
120
+ spellr (0.11.0)
121
+ fast_ignore (>= 0.11.0)
122
+ jaro_winkler
123
+ parallel (~> 1.0)
111
124
  to_bool (2.0.0)
112
125
  tzinfo (2.0.5)
113
126
  concurrent-ruby (~> 1.0)
114
- unicode-display_width (2.2.0)
127
+ unicode-display_width (2.3.0)
115
128
  webmock (3.18.0)
116
129
  addressable (>= 2.8.0)
117
130
  crack (>= 0.3.2)
118
131
  hashdiff (>= 0.4.0, < 2.0.0)
119
132
 
120
133
  PLATFORMS
134
+ ruby
121
135
  x86_64-darwin-18
122
136
  x86_64-darwin-20
137
+ x86_64-darwin-21
123
138
  x86_64-linux
124
139
 
125
140
  DEPENDENCIES
@@ -131,10 +146,11 @@ DEPENDENCIES
131
146
  pry-rescue
132
147
  pry-stack_explorer
133
148
  rspec (>= 3.0)
134
- rubocop
135
- rubocop-rspec
149
+ rubocop (~> 1.35)
150
+ rubocop-rspec (~> 2.12)
151
+ spellr (~> 0.11)
136
152
  to_bool
137
153
  webmock (>= 3.0)
138
154
 
139
155
  BUNDLED WITH
140
- 2.3.13
156
+ 2.3.15
@@ -2,6 +2,6 @@
2
2
 
3
3
  module Fera
4
4
  module API
5
- VERSION = "0.1.3"
5
+ VERSION = "0.2.3"
6
6
  end
7
7
  end
data/lib/fera/api.rb CHANGED
@@ -19,23 +19,18 @@ module Fera
19
19
  ##
20
20
  # @param api_key [String] Public API key, Secret API key or Auth Token (if app)
21
21
  # @return [Object, ::Fera::API] Result of the block operation if given, otherwise self
22
- def self.configure(api_key, api_url: nil, strict_mode: false, debug_mode: false)
23
- previous_base_site = Base.site
24
- previous_base_headers = Base.headers
22
+ def self.configure(api_key, api_url: nil, strict_mode: false, debug_mode: false, api_type: nil)
23
+ previous_base_site = Base.site.dup
24
+ previous_base_headers = Base.headers.dup
25
+ previous_debug_mode = @debug_mode
25
26
 
26
27
  api_url ||= 'https://api.fera.ai'
27
- Base.site = "#{ api_url.chomp('/') }/v3/private"
28
+ api_type ||= api_key.include?('sk_') ? 'private' : 'public'
29
+ Base.site = "#{ api_url.chomp('/') }/v3/#{ api_type }"
28
30
 
29
31
  @debug_mode = debug_mode
30
32
 
31
- if api_key =~ /^sk_/
32
- Base.headers['Secret-Key'] = api_key
33
- elsif api_key =~ /^pk_/
34
- Base.headers['Public-Key'] = api_key
35
- else
36
- Base.headers['Authorization'] = "Bearer #{ api_key }"
37
- end
38
-
33
+ Base.api_key = api_key
39
34
  Base.headers['Strict-Mode'] = strict_mode if strict_mode
40
35
 
41
36
  if block_given?
@@ -43,9 +38,8 @@ module Fera
43
38
  result = yield
44
39
  ensure
45
40
  Base.site = previous_base_site
46
- previous_base_headers.each do |key, value|
47
- Base.headers[key] = value
48
- end
41
+ Base.headers = previous_base_headers
42
+ @debug_mode = previous_debug_mode
49
43
  end
50
44
 
51
45
  result
@@ -56,6 +50,10 @@ module Fera
56
50
 
57
51
  def self.debug_mode?; @debug_mode; end
58
52
 
53
+ ##
54
+ # @option client_id [String] Fera app Client ID
55
+ # @option client_secret [String] Fera app Client secret
56
+ # @option auth_token [String] Auth token you wish to revoke access for.
59
57
  def self.revoke_token!(client_id:, client_secret:, auth_token:)
60
58
  previous_site = Base.site
61
59
 
@@ -8,6 +8,52 @@ module Fera
8
8
  self.site ||= "https://api.fera.ai/v3/private"
9
9
 
10
10
  class << self
11
+ ##
12
+ # Sets the header API key for subsequent requests
13
+ # @param api_key [String] Secret Key, Public Key or OAuth Access Token.
14
+ def api_key=(api_key)
15
+ if api_key.blank?
16
+ self.headers.delete('Secret-Key')
17
+ self.headers.delete('Public-Key')
18
+ self.headers.delete('Authorization')
19
+ elsif api_key =~ /^sk_/
20
+ self.headers['Secret-Key'] = api_key
21
+ elsif api_key =~ /^pk_/
22
+ self.headers['Public-Key'] = api_key
23
+ else
24
+ self.headers['Authorization'] = "Bearer #{ api_key }"
25
+ end
26
+ end
27
+
28
+ ##
29
+ # Sets all the headers for subsequent requests
30
+ # @param new_headers [Hash] Hash of new headers to set
31
+ def headers=(new_headers)
32
+ new_headers.to_h.each do |key, value|
33
+ self.headers[key] = value
34
+ end
35
+
36
+ self.headers.to_h.each do |key, _|
37
+ self.headers.delete(key) unless new_headers.key?(key)
38
+ end
39
+ end
40
+
41
+ def api_key
42
+ self.headers['Secret-Key'] || self.headers['Public-Key'] || self.headers['Authorization'].to_s.split.last.presence
43
+ end
44
+
45
+ ##
46
+ # Returns sorted results.
47
+ # @note This only works from the root, not with scoped results (`Fera::Review.order(created_at: :asc)`)
48
+ # @param sorts [Hash, String, Symbol]
49
+ def order(sorts)
50
+ sorts = { sorts.to_s => :desc.to_s } if sorts.is_a?(String) || sorts.is_a?(Symbol)
51
+ sort_by = sorts.map do |column, direction|
52
+ "#{ column }:#{ direction.presence || :desc }"
53
+ end.join(",")
54
+ where(sort_by: sort_by)
55
+ end
56
+
11
57
  def belongs_to(name, options = {})
12
58
  @belongs_tos = @belongs_tos.to_h.merge(name => options)
13
59
  end
@@ -285,7 +331,7 @@ module Fera
285
331
  end
286
332
 
287
333
  #
288
- # Method missing adapters to define public_*_id
334
+ # Method missing adapters to define is_* methods for boolean attributes
289
335
  #
290
336
 
291
337
  def method_missing(method_name, *args, &block)
@@ -0,0 +1,52 @@
1
+ require 'active_support/concern'
2
+
3
+ module Fera
4
+ module HasTimestampAction
5
+ extend ActiveSupport::Concern
6
+
7
+ module ClassMethods
8
+ # define API actions that set a timestamp on the model
9
+ # @example
10
+ # class Order < Fera::Base
11
+ # include HasTimestampAction
12
+ #
13
+ # timestamp_action deliver: :delivered
14
+ # end
15
+ #
16
+ # routes to `PUT /orders/1/deliver`
17
+ #
18
+ # order = Order.find(1)
19
+ # order.delivered? # => false
20
+ # order.deliver!(Time.now)
21
+ # order.delivered? # => true
22
+ # order.delivered_at # => 2018-01-01 00:00:00 UTC
23
+ #
24
+ # or
25
+ #
26
+ # Fera::Order.deliver!(1, Time.now.utc)
27
+ #
28
+ # @param [Array<Symbol>] actions
29
+ def timestamp_action(args)
30
+ args.each do |action, state|
31
+ define_method("#{ action }!") do |at = nil|
32
+ changed_attributes = { "#{ state }_at": at.presence || Time.now.utc }
33
+
34
+ put(action, changed_attributes)
35
+
36
+ load(changed_attributes)
37
+
38
+ true
39
+ end
40
+
41
+ define_method("#{ state }?") do
42
+ send("#{ state }_at?")
43
+ end
44
+
45
+ define_singleton_method("#{ action }!") do |id, at = nil|
46
+ find(id).send("#{ action }!", at)
47
+ end
48
+ end
49
+ end
50
+ end
51
+ end
52
+ end
@@ -5,6 +5,7 @@ module Fera
5
5
  include BelongsToProduct
6
6
  include BelongsToReview
7
7
  include BelongsToSubmission
8
+ include BelongsToOrder
8
9
 
9
10
  after_create :remove_file_param
10
11
 
@@ -1,5 +1,8 @@
1
1
  module Fera
2
2
  class Order < Base
3
3
  include BelongsToCustomer
4
+ include HasTimestampAction
5
+
6
+ timestamp_action pay: :paid, deliver: :delivered, fulfill: :fulfilled
4
7
  end
5
8
  end
@@ -5,6 +5,7 @@ module Fera
5
5
  include BelongsToCustomer
6
6
  include BelongsToProduct
7
7
  include BelongsToSubmission
8
+ include BelongsToOrder
8
9
 
9
10
  def only_rating?
10
11
  body.blank? && heading.blank?
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: fera-api
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.3
4
+ version: 0.2.3
5
5
  platform: ruby
6
6
  authors:
7
7
  - Fera Commerce Inc
8
8
  autorequire:
9
9
  bindir: exe
10
10
  cert_chain: []
11
- date: 2022-09-02 00:00:00.000000000 Z
11
+ date: 2022-11-07 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: activemodel
@@ -201,6 +201,7 @@ files:
201
201
  - lib/fera/models/concerns/has_many_submissions.rb
202
202
  - lib/fera/models/concerns/has_media.rb
203
203
  - lib/fera/models/concerns/has_subject.rb
204
+ - lib/fera/models/concerns/has_timestamp_action.rb
204
205
  - lib/fera/models/customer.rb
205
206
  - lib/fera/models/media.rb
206
207
  - lib/fera/models/order.rb