fera-api 0.1.2 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 340f111ef9ae910374f8b8556b80a4c7cea4a982be22c807e1330b52f5a222a8
-  data.tar.gz: 758fe26ac14a9a4012039d14800e657690d821862eda47ea8e0866ea714a16d1
+  metadata.gz: 350de7865e484558dd53c2c4e4635b679baf32d9fbf11619e19995e2add14eae
+  data.tar.gz: c758c1e080ef27a9ece0f88edb515f9ece137b1158986a216f98444ea38f3e7c
 SHA512:
-  metadata.gz: db7db0bd5a14e64dce22219b385d21db5675ddc5dc07196756c2a88dc20cb628786a48e911b5ad638b741c2124be96e7008dff341366d4a7ab83e827b767d5b5
-  data.tar.gz: 53ea2d445404901fc1377edd5720f186e3cccad97eafd420f4e13959fedb55d8778ca39847e3eb2622226b06b9261e5fbc38417f3d23a523acfe083701f84303
+  metadata.gz: b833c34953d53e50618cdbaebfd217b6532dd6adbe4f0947ac26a00e95ddf8483ea09f6abb557b91f06c014411f264cc7fecb8d4c9d64cfd757c3161f1291d0b
+  data.tar.gz: 8c00efeddbdf2280b524f0ae536e5d4c76814dda70f7b0bda5d47abe62029e4ad2bd3b3dd2ae4873f04f9d8a692fb1509e36fcae3b9ab4ece486eeb31d740bcd

data/.rubocop.yml

@@ -1,173 +1,10 @@
-# Base was copied from https://github.com/sider/meowcop/blob/master/config/rubocop.yml which is what Sider uses by default
+inherit_from:
+  - 'https://raw.githubusercontent.com/feracommerce/code-standards/master/.rubocop.yml'
+  - 'https://raw.githubusercontent.com/feracommerce/code-standards/master/.rubocop-rspec.yml'
+inherit_mode:
+  merge:
+    - Exclude
 AllCops:
   TargetRubyVersion: 2.3
-  Exclude:
-    - 'vendor/**/*'
-    - 'db/schema.rb'
-    - 'node_modules/**/*'
-    - 'tmp/**/*'
-    - 'lib/tasks/one_offs/**/*' # We don't really care about linting one-off tasks
-    - 'app/migrators/**/*' # Migrators are one-off tasks so there isn't much need to lint them
-  DisplayCopNames: true
-  DisplayStyleGuide: true
-  NewCops: enable
-
-Lint/NonLocalExitFromIterator:
-  Enabled: false # We actually believe that it is more readable with premature returns
-Layout/BeginEndAlignment:
-  Enabled: false # We believe it's more readable to have begin blocks aligned to the end blocks (and also helps with code smells)
-Lint/AmbiguousRegexpLiteral:
-  Enabled: false
-Lint/AssignmentInCondition:
-  Enabled: false
-Metrics/AbcSize:
-  Max: 60
-# Use the default setting
-Metrics/BlockLength:
-  Max: 200
-  Exclude:
-    # RuboCop's default
-    - 'Rakefile'
-    - '**/*.rake'
-    # In many cases, config/routes.rb has very long block
-    - 'config/routes.rb'
-Metrics/ClassLength:
-  Enabled: false
-Metrics/CyclomaticComplexity:
-  Max: 60
-Metrics/MethodLength:
-  Enabled: false
-Metrics/ModuleLength:
-  Enabled: false
-Metrics/ParameterLists:
-  Max: 5
-Metrics/PerceivedComplexity:
-  Enabled: false
-Layout/ArgumentAlignment:
-  Enabled: false
-Layout/HashAlignment:
-  Enabled: false
-Layout/ParameterAlignment:
-  Enabled: false
-Layout/IndentationWidth:
-  Enabled: false
-Layout/FirstHashElementIndentation:
-  Enabled: false
-Layout/HeredocIndentation:
-  Enabled: false
-Layout/LineLength:
-  Max: 200
-  AllowedPatterns: ['^\s*#', '^\s*([a-zA-Z]*[lL]og[a-zA-Z]*)[ (]', '^\s*[''"]', '.*#.{30,300}', '^\s*[a-z_]:\s*".+",?[}\s]*$']
-Layout/MultilineArrayBraceLayout:
-  Enabled: false
-Layout/MultilineAssignmentLayout:
-  Enabled: false
-Layout/MultilineBlockLayout:
-  Enabled: false
-Layout/MultilineHashBraceLayout:
-  Enabled: false
-Layout/MultilineMethodCallBraceLayout:
-  Enabled: false
-Layout/MultilineMethodCallIndentation:
-  Enabled: false
-Layout/MultilineMethodDefinitionBraceLayout:
-  Enabled: false
-Layout/MultilineOperationIndentation:
-  Enabled: false
-Layout/RescueEnsureAlignment:
-  Enabled: false
-Layout/SpaceAfterNot:
-  Enabled: false
-Layout/SpaceBeforeBlockBraces:
-  Enabled: false
-Layout/SpaceInLambdaLiteral:
-  Enabled: false
-Layout/SpaceInsideStringInterpolation:
-  EnforcedStyle: space
-Naming/PredicateName:
-  Enabled: false # As of February 2022 we now want some methods to have is_ prefix so it is congruent with JavaScript
-Naming/VariableNumber:
-  Enabled: false
-Style/AsciiComments:
-  Enabled: false # It's 2022, emojis are everywhere
-Style/Alias:
-  EnforcedStyle: prefer_alias_method
-Style/CaseLikeIf:
-  Enabled: false
-Style/CommentAnnotation:
-  Enabled: false # Don't really care about being picky on comments like this. Not worth slowing down the developer.
-Style/CommentedKeyword:
-  Enabled: false # We want to allow comments on single-line method definitions like `# @alias`
-Style/ConstantVisibility:
-  Enabled: false
-Style/Copyright:
-  Enabled: false
-Style/DisableCopsWithinSourceCodeDirective:
-  Enabled: false # Allow disabling cops and we will use PRs to determine whether it should be enforced
-Style/Documentation:
-  Enabled: false # We will decide in PR whether public method should be documented or not.
-Style/DocumentationMethod:
-  Enabled: false # We will decide in PR whether public method should be documented or not.
-Style/EmptyElse:
-  AllowComments: true # When a comment is there then it means the programmer thought about the case so we can ignore it.
-  EnforcedStyle: empty  # When a comment or nil is there it means the programmer thought about the case, so there is no need for concern
-Style/FloatDivision:
-  Enabled: false # Sometimes we're trying to force the number to become a float and it could be nil
-Style/FrozenStringLiteralComment:
-  Enabled: false
-Style/GlobalVars:
-  Enabled: false # If we're using global variables, we have a darn good reason or it should be blocked in the PR
-Style/IfUnlessModifier:
-  Enabled: false # This isn't always easier to read. Sometimes you want to put the IF in front of the block of code to make it more clear.
-Style/ImplicitRuntimeError:
-  Enabled: false # These are actually readable as long as we all know that they represent a RuntimeError
-Style/InlineComment:
-  Enabled: false # Trailing inline comments are pretty compact and more readable
-Style/Lambda:
-  Enabled: false
-Style/LambdaCall:
-  Enabled: false
-Style/MethodCallWithArgsParentheses:
-  Enabled: false
-Style/MethodCallWithoutArgsParentheses:
-  Enabled: true # We use whatever is more readable
-Style/MethodCalledOnDoEndBlock:
-  Enabled: false # Actually don't mind these - they look more readable
-Style/MissingElse:
-  Enabled: false # Sometimes it's obvious we don't care about the else case (e.g. if we're prematurely returning from method)
-Style/MultilineBlockChain:
-  Enabled: false # Sometimes these are more readable
-Style/MutableConstant:
-  Enabled: false
-Style/MapToHash:
-  Enabled: false # We believe it's more readable to use map vs hash with block syntax
-Style/NumericPredicate:
-  Enabled: false # .zero? and .positive? are a bit less readable than == 0 IMO
-Style/OptionHash:
-  Enabled: false # It is more intuitive to pass option hashes to other objects in many times
-Style/OpenStructUse:
-  Enabled: false
-Style/RedundantRegexpCharacterClass:
-  Enabled: false # No need to make regexp less readable than they already are by reducing redundancy
-Style/RedundantRegexpEscape:
-  Enabled: false # No need to make regexp less readable than they already are by reducing redundancy
-Style/RedundantSelf:
-  Enabled: false # Sometimes it's actually more readable to explicitly reference self
-Style/RegexpLiteral:
-  Enabled: false
-Style/ReturnNil:
-  Enabled: false # Returning nil is more clear what is happening and can prevent issues with returning mixed types
-Style/Send:
-  Enabled: false
-Style/SingleLineMethods:
-  Enabled: false # Sometimes these are more compact and easier to read. No need to spam our file with simple method definitions.
-Style/StringLiterals:
-  Enabled: false
-Style/SymbolArray:
-  Enabled: false
-Style/TernaryParentheses:
-  Enabled: false
-Style/TrailingCommaInArrayLiteral:
-  EnforcedStyleForMultiline: consistent_comma # It makes managing arrays much easier when we have commas at the end
-Style/TrailingCommaInHashLiteral:
-  EnforcedStyleForMultiline: consistent_comma # It makes managing hashes much easier when we have commas at the end
+require:
+  - rubocop-rspec

data/Gemfile

@@ -6,11 +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", "~> 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.2)
+    fera-api (0.2.2)
       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.5.2)
+      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.0)
+    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.2)
+    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,20 +112,29 @@ GEM
       unicode-display_width (>= 1.4.0, < 3.0)
     rubocop-ast (1.21.0)
       parser (>= 3.1.1.0)
+    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
@@ -129,9 +146,11 @@ DEPENDENCIES
   pry-rescue
   pry-stack_explorer
   rspec (>= 3.0)
-  rubocop
+  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.2"
+    VERSION = "0.2.2"
   end
 end

data/lib/fera/api.rb

@@ -18,23 +18,19 @@ module Fera
 
     ##
     # @param api_key [String] Public API key, Secret API key or Auth Token (if app)
-    def self.configure(api_key, api_url: nil, strict_mode: false, debug_mode: false)
-      previous_base_site = Base.site
-      previous_base_headers = Base.headers
+    # @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, 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?
@@ -42,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
@@ -55,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
@@ -209,7 +255,7 @@ module Fera
           end
         end
 
-        connection.post(collection_path(nil, extra_params), data.to_json, self.class.headers).tap do |response|
+        connection.post(collection_path(nil, extra_params), { data: data }.to_json, self.class.headers).tap do |response|
           self.id = id_from_response(response)
           load_attributes_from_response(response)
         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/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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fera-api
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.2
 platform: ruby
 authors:
 - Fera Commerce Inc
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-08-17 00:00:00.000000000 Z
+date: 2022-11-06 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