fera-api 0.1.3 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5f5fcef6bfad094e9853066b852f6992540e9321015531350e7bc6b02b94d71e
-  data.tar.gz: eff0b267a65ad12bbb8bb42c24c42409224774e1e45a53005e1fecf0b0be5fa2
+  metadata.gz: a57edbe52b6971a3d74201e5313ebe1f06166d2efa8f0be1013d3f4809c64c69
+  data.tar.gz: 5d435cfed0ec28813cb6501c97f7919d0bf3197d946cbd9a4dd08687b30dc0d7
 SHA512:
-  metadata.gz: d0e8f790bdcced7f48af3b8d0f2e59773e3a69ec429b584068ad5d769cdb39835b87c4301f012ed3da06af8b9ffecb1e21e5ce69e94265472473be543996bb46
-  data.tar.gz: 49380fcbb2c591cb0c7c7c730e38bde23a17f3ce1ab59af08c3b6e340700932bc5219af9c11a0bc55e92201ccba8dcd9ada8ee053edae6f3a0faf656967434fe
+  metadata.gz: f7951d6031da2542091c04c23092bfb89d4b60c2666c00883a067aa5a25b07c4ea9cf1f44695ebc7a55706621fc55f992d4eec8b39b90b29f3822b447dbbd822
+  data.tar.gz: c9ab5cffab575258f506eb6ffec0fed26c2fa1e4c5e04f22e77b2849153f62f97f7a73f18c522a7788bb39f586cebf78c9f6599ecc51e6f33a54817e24cf299a

data/Gemfile

@@ -6,12 +6,10 @@ source "https://rubygems.org"
 gemspec
 
 group :development, :test do
-  gem "pry"
-  gem "pry-byebug"
   gem "pry-rails"
   gem "pry-remote"
   gem "pry-rescue"
-  gem "pry-stack_explorer"
-  gem "rubocop"
-  gem "rubocop-rspec"
+  gem "rubocop", "~> 1.35"
+  gem "rubocop-rspec", "~> 2.12"
+  gem "spellr", "~> 0.11"
 end

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    fera-api (0.1.3)
+    fera-api (0.2.3)
       activemodel (>= 4)
       activeresource (>= 6)
       activesupport (>= 4.0)
@@ -11,8 +11,8 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (7.0.3.1)
-      activesupport (= 7.0.3.1)
+    activemodel (7.0.4)
+      activesupport (= 7.0.4)
     activemodel-serializers-xml (1.0.2)
       activemodel (> 5.x)
       activesupport (> 5.x)
@@ -21,7 +21,7 @@ GEM
       activemodel (>= 6.0)
       activemodel-serializers-xml (~> 1.0)
       activesupport (>= 6.0)
-    activesupport (7.0.3.1)
+    activesupport (7.0.4)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
@@ -30,7 +30,7 @@ GEM
       public_suffix (>= 2.0.2, < 5.0)
     aes_key_wrap (1.1.0)
     ast (2.4.2)
-    bindata (2.4.10)
+    bindata (2.4.14)
     binding_of_caller (1.0.0)
       debug_inspector (>= 0.0.1)
     builder (3.2.4)
@@ -41,17 +41,25 @@ GEM
       rexml
     debug_inspector (1.1.0)
     diff-lcs (1.5.0)
+    faraday (2.6.0)
+      faraday-net_http (>= 2.0, < 3.1)
+      ruby2_keywords (>= 0.0.4)
+    faraday-follow_redirects (0.3.0)
+      faraday (>= 1, < 3)
+    faraday-net_http (3.0.1)
+    fast_ignore (0.17.4)
     hashdiff (1.0.1)
-    httpclient (2.8.3)
     i18n (1.12.0)
       concurrent-ruby (~> 1.0)
     interception (0.5)
+    jaro_winkler (1.5.4)
     json (2.6.2)
-    json-jwt (1.15.3)
+    json-jwt (1.16.1)
       activesupport (>= 4.2)
       aes_key_wrap
       bindata
-      httpclient
+      faraday (~> 2.0)
+      faraday-follow_redirects
     method_source (1.0.0)
     minitest (5.16.3)
     parallel (1.22.1)
@@ -92,7 +100,7 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.11.0)
     rspec-support (3.11.0)
-    rubocop (1.35.0)
+    rubocop (1.35.1)
       json (~> 2.3)
       parallel (~> 1.10)
       parser (>= 3.1.2.1)
@@ -104,22 +112,29 @@ GEM
       unicode-display_width (>= 1.4.0, < 3.0)
     rubocop-ast (1.21.0)
       parser (>= 3.1.1.0)
-    rubocop-rspec (2.12.1)
-      rubocop (~> 1.31)
+    rubocop-rspec (2.13.1)
+      rubocop (~> 1.33)
     ruby-progressbar (1.11.0)
+    ruby2_keywords (0.0.5)
     slop (3.6.0)
+    spellr (0.11.0)
+      fast_ignore (>= 0.11.0)
+      jaro_winkler
+      parallel (~> 1.0)
     to_bool (2.0.0)
     tzinfo (2.0.5)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (2.2.0)
+    unicode-display_width (2.3.0)
     webmock (3.18.0)
       addressable (>= 2.8.0)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
 
 PLATFORMS
+  ruby
   x86_64-darwin-18
   x86_64-darwin-20
+  x86_64-darwin-21
   x86_64-linux
 
 DEPENDENCIES
@@ -131,10 +146,11 @@ DEPENDENCIES
   pry-rescue
   pry-stack_explorer
   rspec (>= 3.0)
-  rubocop
-  rubocop-rspec
+  rubocop (~> 1.35)
+  rubocop-rspec (~> 2.12)
+  spellr (~> 0.11)
   to_bool
   webmock (>= 3.0)
 
 BUNDLED WITH
-   2.3.13
+   2.3.15

data/lib/fera/api/version.rb

@@ -2,6 +2,6 @@
 
 module Fera
   module API
-    VERSION = "0.1.3"
+    VERSION = "0.2.3"
   end
 end

data/lib/fera/api.rb

@@ -19,23 +19,18 @@ module Fera
     ##
     # @param api_key [String] Public API key, Secret API key or Auth Token (if app)
     # @return [Object, ::Fera::API] Result of the block operation if given, otherwise self
-    def self.configure(api_key, api_url: nil, strict_mode: false, debug_mode: false)
-      previous_base_site = Base.site
-      previous_base_headers = Base.headers
+    def self.configure(api_key, api_url: nil, strict_mode: false, debug_mode: false, api_type: nil)
+      previous_base_site = Base.site.dup
+      previous_base_headers = Base.headers.dup
+      previous_debug_mode = @debug_mode
 
       api_url ||= 'https://api.fera.ai'
-      Base.site = "#{ api_url.chomp('/') }/v3/private"
+      api_type ||= api_key.include?('sk_') ? 'private' : 'public'
+      Base.site = "#{ api_url.chomp('/') }/v3/#{ api_type }"
 
       @debug_mode = debug_mode
 
-      if api_key =~ /^sk_/
-        Base.headers['Secret-Key'] = api_key
-      elsif api_key =~ /^pk_/
-        Base.headers['Public-Key'] = api_key
-      else
-        Base.headers['Authorization'] = "Bearer #{ api_key }"
-      end
-
+      Base.api_key = api_key
       Base.headers['Strict-Mode'] = strict_mode if strict_mode
 
       if block_given?
@@ -43,9 +38,8 @@ module Fera
           result = yield
         ensure
           Base.site = previous_base_site
-          previous_base_headers.each do |key, value|
-            Base.headers[key] = value
-          end
+          Base.headers = previous_base_headers
+          @debug_mode = previous_debug_mode
         end
 
         result
@@ -56,6 +50,10 @@ module Fera
 
     def self.debug_mode?; @debug_mode; end
 
+    ##
+    # @option client_id [String] Fera app Client ID
+    # @option client_secret [String] Fera app Client secret
+    # @option auth_token [String] Auth token you wish to revoke access for.
     def self.revoke_token!(client_id:, client_secret:, auth_token:)
       previous_site = Base.site
 

data/lib/fera/models/base.rb

@@ -8,6 +8,52 @@ module Fera
     self.site ||= "https://api.fera.ai/v3/private"
 
     class << self
+      ##
+      # Sets the header API key for subsequent requests
+      # @param api_key [String] Secret Key, Public Key or OAuth Access Token.
+      def api_key=(api_key)
+        if api_key.blank?
+          self.headers.delete('Secret-Key')
+          self.headers.delete('Public-Key')
+          self.headers.delete('Authorization')
+        elsif api_key =~ /^sk_/
+          self.headers['Secret-Key'] = api_key
+        elsif api_key =~ /^pk_/
+          self.headers['Public-Key'] = api_key
+        else
+          self.headers['Authorization'] = "Bearer #{ api_key }"
+        end
+      end
+
+      ##
+      # Sets all the headers for subsequent requests
+      # @param new_headers [Hash] Hash of new headers to set
+      def headers=(new_headers)
+        new_headers.to_h.each do |key, value|
+          self.headers[key] = value
+        end
+
+        self.headers.to_h.each do |key, _|
+          self.headers.delete(key) unless new_headers.key?(key)
+        end
+      end
+
+      def api_key
+        self.headers['Secret-Key'] || self.headers['Public-Key'] || self.headers['Authorization'].to_s.split.last.presence
+      end
+
+      ##
+      # Returns sorted results.
+      # @note This only works from the root, not with scoped results (`Fera::Review.order(created_at: :asc)`)
+      # @param sorts [Hash, String, Symbol]
+      def order(sorts)
+        sorts = { sorts.to_s => :desc.to_s } if sorts.is_a?(String) || sorts.is_a?(Symbol)
+        sort_by = sorts.map do |column, direction|
+          "#{ column }:#{ direction.presence || :desc }"
+        end.join(",")
+        where(sort_by: sort_by)
+      end
+
       def belongs_to(name, options = {})
         @belongs_tos = @belongs_tos.to_h.merge(name => options)
       end
@@ -285,7 +331,7 @@ module Fera
     end
 
     #
-    # Method missing adapters to define public_*_id
+    # Method missing adapters to define is_* methods for boolean attributes
     #
 
     def method_missing(method_name, *args, &block)

data/lib/fera/models/concerns/has_timestamp_action.rb

@@ -0,0 +1,52 @@
+require 'active_support/concern'
+
+module Fera
+  module HasTimestampAction
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      # define API actions that set a timestamp on the model
+      # @example
+      #   class Order < Fera::Base
+      #     include HasTimestampAction
+      #
+      #     timestamp_action deliver: :delivered
+      #   end
+      #
+      #   routes to `PUT /orders/1/deliver`
+      #
+      #   order = Order.find(1)
+      #   order.delivered? # => false
+      #   order.deliver!(Time.now)
+      #   order.delivered? # => true
+      #   order.delivered_at # => 2018-01-01 00:00:00 UTC
+      #
+      #   or
+      #
+      #   Fera::Order.deliver!(1, Time.now.utc)
+      #
+      # @param [Array<Symbol>] actions
+      def timestamp_action(args)
+        args.each do |action, state|
+          define_method("#{ action }!") do |at = nil|
+            changed_attributes = { "#{ state }_at": at.presence || Time.now.utc }
+
+            put(action, changed_attributes)
+
+            load(changed_attributes)
+
+            true
+          end
+
+          define_method("#{ state }?") do
+            send("#{ state }_at?")
+          end
+
+          define_singleton_method("#{ action }!") do |id, at = nil|
+            find(id).send("#{ action }!", at)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/fera/models/media.rb

@@ -5,6 +5,7 @@ module Fera
     include BelongsToProduct
     include BelongsToReview
     include BelongsToSubmission
+    include BelongsToOrder
 
     after_create :remove_file_param
 

data/lib/fera/models/order.rb

@@ -1,5 +1,8 @@
 module Fera
   class Order < Base
     include BelongsToCustomer
+    include HasTimestampAction
+
+    timestamp_action pay: :paid, deliver: :delivered, fulfill: :fulfilled
   end
 end

data/lib/fera/models/review.rb

@@ -5,6 +5,7 @@ module Fera
     include BelongsToCustomer
     include BelongsToProduct
     include BelongsToSubmission
+    include BelongsToOrder
 
     def only_rating?
       body.blank? && heading.blank?

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fera-api
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.3
 platform: ruby
 authors:
 - Fera Commerce Inc
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-09-02 00:00:00.000000000 Z
+date: 2022-11-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -201,6 +201,7 @@ files:
 - lib/fera/models/concerns/has_many_submissions.rb
 - lib/fera/models/concerns/has_media.rb
 - lib/fera/models/concerns/has_subject.rb
+- lib/fera/models/concerns/has_timestamp_action.rb
 - lib/fera/models/customer.rb
 - lib/fera/models/media.rb
 - lib/fera/models/order.rb