fera-api 0.1.0 → 0.1.3

data/.spellr_wordlists/html.txt

@@ -0,0 +1 @@
+clearfix

data/.spellr_wordlists/javascript.txt

@@ -0,0 +1,3 @@
+concat
+intl
+swal

data/.spellr_wordlists/ruby.txt

@@ -0,0 +1,22 @@
+cattr
+endcapture
+endfor
+endform
+endif
+evalsha
+hdel
+hget
+hgetall
+hkeys
+hmset
+sadd
+sismember
+smembers
+spop
+srem
+zadd
+zcount
+zrangebyscore
+zrank
+zrem
+zrevrange

data/Gemfile

@@ -5,10 +5,13 @@ source "https://rubygems.org"
 # Specify your gem's dependencies in fera.gemspec
 gemspec
 
-gem "rake", "~> 13.0"
-
 group :development, :test do
-  gem "rspec", "~> 3.0"
-
+  gem "pry"
+  gem "pry-byebug"
+  gem "pry-rails"
+  gem "pry-remote"
+  gem "pry-rescue"
+  gem "pry-stack_explorer"
   gem "rubocop"
+  gem "rubocop-rspec"
 end

data/Gemfile.lock

@@ -1,18 +1,18 @@
 PATH
   remote: .
   specs:
-    fera-api (0.1.0)
+    fera-api (0.1.3)
       activemodel (>= 4)
       activeresource (>= 6)
-      activesupport (>= 5.0)
+      activesupport (>= 4.0)
       json-jwt (>= 1)
       require_all (>= 2)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (6.1.6)
-      activesupport (= 6.1.6)
+    activemodel (7.0.3.1)
+      activesupport (= 7.0.3.1)
     activemodel-serializers-xml (1.0.2)
       activemodel (> 5.x)
       activesupport (> 5.x)
@@ -21,31 +21,62 @@ GEM
       activemodel (>= 6.0)
       activemodel-serializers-xml (~> 1.0)
       activesupport (>= 6.0)
-    activesupport (6.1.6)
+    activesupport (7.0.3.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
-      zeitwerk (~> 2.3)
+    addressable (2.8.0)
+      public_suffix (>= 2.0.2, < 5.0)
     aes_key_wrap (1.1.0)
     ast (2.4.2)
     bindata (2.4.10)
+    binding_of_caller (1.0.0)
+      debug_inspector (>= 0.0.1)
     builder (3.2.4)
+    byebug (11.1.3)
+    coderay (1.1.3)
     concurrent-ruby (1.1.10)
+    crack (0.4.5)
+      rexml
+    debug_inspector (1.1.0)
     diff-lcs (1.5.0)
-    i18n (1.10.0)
+    hashdiff (1.0.1)
+    httpclient (2.8.3)
+    i18n (1.12.0)
       concurrent-ruby (~> 1.0)
-    json-jwt (1.13.0)
+    interception (0.5)
+    json (2.6.2)
+    json-jwt (1.15.3)
       activesupport (>= 4.2)
       aes_key_wrap
       bindata
-    minitest (5.16.0)
+      httpclient
+    method_source (1.0.0)
+    minitest (5.16.3)
     parallel (1.22.1)
-    parser (3.1.2.0)
+    parser (3.1.2.1)
       ast (~> 2.4.1)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.10.1)
+      byebug (~> 11.0)
+      pry (>= 0.13, < 0.15)
+    pry-rails (0.3.9)
+      pry (>= 0.10.4)
+    pry-remote (0.1.8)
+      pry (~> 0.9)
+      slop (~> 3.0)
+    pry-rescue (1.5.2)
+      interception (>= 0.5)
+      pry (>= 0.12.0)
+    pry-stack_explorer (0.6.1)
+      binding_of_caller (~> 1.0)
+      pry (~> 0.13)
+    public_suffix (4.0.7)
     rainbow (3.1.1)
-    rake (13.0.6)
-    regexp_parser (2.4.0)
+    regexp_parser (2.5.0)
     require_all (3.0.0)
     rexml (3.2.5)
     rspec (3.11.0)
@@ -61,32 +92,49 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.11.0)
     rspec-support (3.11.0)
-    rubocop (1.29.0)
+    rubocop (1.35.0)
+      json (~> 2.3)
       parallel (~> 1.10)
-      parser (>= 3.1.0.0)
+      parser (>= 3.1.2.1)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.17.0, < 2.0)
+      rubocop-ast (>= 1.20.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.17.0)
+    rubocop-ast (1.21.0)
       parser (>= 3.1.1.0)
+    rubocop-rspec (2.12.1)
+      rubocop (~> 1.31)
     ruby-progressbar (1.11.0)
-    tzinfo (2.0.4)
+    slop (3.6.0)
+    to_bool (2.0.0)
+    tzinfo (2.0.5)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (2.1.0)
-    zeitwerk (2.5.4)
+    unicode-display_width (2.2.0)
+    webmock (3.18.0)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
 
 PLATFORMS
   x86_64-darwin-18
   x86_64-darwin-20
+  x86_64-linux
 
 DEPENDENCIES
   fera-api!
-  rake (~> 13.0)
-  rspec (~> 3.0)
+  pry
+  pry-byebug
+  pry-rails
+  pry-remote
+  pry-rescue
+  pry-stack_explorer
+  rspec (>= 3.0)
   rubocop
+  rubocop-rspec
+  to_bool
+  webmock (>= 3.0)
 
 BUNDLED WITH
    2.3.13

data/README.md

@@ -1,4 +1,7 @@
-# Introduction
+[![Checks](https://github.com/feracommerce/fera-api-ruby/actions/workflows/checks.yml/badge.svg)](https://github.com/feracommerce/fera-api-ruby/actions/workflows/checks.yml)
+[![Tests](https://github.com/feracommerce/fera-api-ruby/actions/workflows/tests.yml/badge.svg)](https://github.com/feracommerce/fera-api-ruby/actions/workflows/tests.yml)
+
+# Fera API Ruby Client
 
 Welcome to the Fera API gem for Ruby. This gem is Fera's official Ruby SDK and make it easy to interact with the Fera API.
 
@@ -9,7 +12,7 @@ Fera API Developer Docs and API Reference can be found at: [https://developers.f
 Install the gem and add to the application's Gemfile by executing:
 
 ```ruby
-  gem 'fera', '~> 0.1'
+  gem 'fera-api'
 ```
 
 # Configuration

data/lib/fera/api/version.rb

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

data/lib/fera/api.rb

@@ -18,11 +18,15 @@ 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)
+    # @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
 
-      Base.site = api_url || 'https://api.fera.ai/v3/private'
+      api_url ||= 'https://api.fera.ai'
+      Base.site = "#{ api_url.chomp('/') }/v3/private"
+
+      @debug_mode = debug_mode
 
       if api_key =~ /^sk_/
         Base.headers['Secret-Key'] = api_key
@@ -48,9 +52,10 @@ module Fera
       else
         self
       end
-
     end
 
+    def self.debug_mode?; @debug_mode; end
+
     def self.revoke_token!(client_id:, client_secret:, auth_token:)
       previous_site = Base.site
 

data/lib/fera/app.rb

@@ -29,5 +29,8 @@ module Fera
       nil
     end
 
+    def encode_jwt(payload)
+      JWT.encode(payload, @client_secret)
+    end
   end
 end

data/lib/fera/models/base.rb

@@ -2,11 +2,10 @@ require_relative './collection'
 
 module Fera
   class Base < ActiveResource::Base
-    # include ActiveModel::Dirty
-
     attr_reader :last_response, :last_response_body, :last_response_message, :last_response_exception, :options
 
     self.collection_parser = ::Fera::Collection
+    self.site ||= "https://api.fera.ai/v3/private"
 
     class << self
       def belongs_to(name, options = {})
@@ -33,13 +32,11 @@ module Fera
         elsif superclass != Object && superclass.headers
           superclass.headers
         else
-          _headers ||= {}
+          _headers ||= {} # rubocop:disable Lint/UnderscorePrefixedVariableName
         end
       end
 
-      def default_params=(default_params)
-        @default_params = default_params
-      end
+      attr_writer :default_params
 
       ##
       # @override to support extra_params
@@ -80,7 +77,7 @@ module Fera
       end
 
       def new_element_path(prefix_options = {}, extra_params = {})
-        url = "#{prefix(prefix_options)}#{collection_name}/new#{format_extension}"
+        url = "#{ prefix(prefix_options) }#{ collection_name }/new#{ format_extension }"
         url += "?#{ extra_params.to_param }" if extra_params.present?
         url
       end
@@ -108,12 +105,14 @@ module Fera
 
       super(dynamic_attributes, persisted)
 
-      association_keys.each do |name, opts|
+      return unless attributes.present?
+
+      association_keys.each do |name, _opts|
         if attributes.key?(name.to_s) || attributes.key?(name.to_sym)
           val = attributes.to_h[name.to_s] || attributes.to_h[name.to_sym]
           self.send("#{ name }=", val) if respond_to?("#{ name }=")
         end
-      end if attributes.present?
+      end
     end
 
     def load(attributes, *args)
@@ -135,18 +134,24 @@ module Fera
     end
 
     def created_at=(new_created_at)
-      return super(Time.parse(new_created_at)) if new_created_at.is_a?(String)
-      super
+      if new_created_at.is_a?(String)
+        super(Time.parse(new_created_at))
+      else
+        super
+      end
     end
 
     def updated_at=(new_updated_at)
-      return super(Time.parse(new_updated_at)) if new_updated_at.is_a?(String)
-      super
+      if new_updated_at.is_a?(String)
+        super(Time.parse(new_updated_at))
+      else
+        super
+      end
     end
 
-    def update(changed_attributes, extra_params = {}, raise = false)
+    def update(changed_attributes, extra_params = {}, raise: false)
       run_callbacks(:update) do
-        connection.put(element_path(prefix_options, extra_params), dynamic_changed_attributes.to_json, self.class.headers).tap do |response|
+        connection.put(element_path(prefix_options, extra_params), changed_attributes.to_json, self.class.headers).tap do |response|
           load_attributes_from_response(response)
         end
 
@@ -165,21 +170,21 @@ module Fera
     end
 
     def update!(changed_attributes, extra_params = {})
-      update(changed_attributes, extra_params, true)
+      update(changed_attributes, extra_params, raise: true)
     end
 
-    def valid?(context = nil)
+    def valid?(_context = nil)
       super()
     end
 
     ##
-    # @override to add exgtra params
-    def create(extra_params = {}, raise = false)
+    # @override to add extra params
+    def create(extra_params = {}, raise: false)
       run_callbacks :create do
-
         data = as_json
-        (self.class.belongs_tos.merge(self.class.has_ones)).each do |name, opts|
+        self.class.belongs_tos.merge(self.class.has_ones).each do |name, _opts|
           next unless instance_variable_defined?(:"@#{ name }")
+
           nested_resource = self.send(name)
           if nested_resource.present? && !nested_resource.persisted?
             nested_resource.validate!
@@ -187,8 +192,9 @@ module Fera
           end
         end
 
-        self.class.has_manys.each do |name, opts|
+        self.class.has_manys.each do |name, _opts|
           next unless instance_variable_defined?(:"@#{ name }")
+
           nested_resource = self.send(name)
 
           next if nested_resource.nil?
@@ -203,7 +209,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
@@ -221,13 +227,13 @@ module Fera
     end
 
     def create!(extra_params = {})
-      create(extra_params, true)
+      create(extra_params, raise: true)
     end
 
-    def save(extra_params = {}, raise = false)
+    def save(extra_params = {}, raise: false)
       run_callbacks :save do
         if new?
-          create(extra_params, raise) # We'll raise the error below
+          create(extra_params, raise: raise) # We'll raise the error below
         else
           # find changes
           changed_attributes = attributes.filter { |key, value| !@clean_copy.attributes.key?(key) || (@clean_copy.attributes[key] != value) || (key == self.class.primary_key) }
@@ -235,23 +241,22 @@ module Fera
           return false unless changed_attributes.keys.any?
 
           # save
-          update(changed_attributes, extra_params, raise)
+          update(changed_attributes, extra_params, raise: raise)
         end
 
         @clean_copy = clone_with_nil # Clear changes
 
         self
       end
-
     end
 
     def save!(extra_params = {})
-      save(extra_params, true)
+      save(extra_params, raise: true)
     end
 
     def clone_with_nil
       # Clone all attributes except the pk and any nested ARes
-      cloned = Hash[attributes.reject { |k, v| k == self.class.primary_key || v.is_a?(ActiveResource::Base) }.map { |k, v| [k, v.clone] }]
+      cloned = attributes.reject { |k, v| k == self.class.primary_key || v.is_a?(ActiveResource::Base) }.map { |k, v| [k, v.clone] }.to_h
       # Form the new resource - bypass initialize of resource with 'new' as that will call 'load' which
       # attempts to convert hashes into member objects and arrays into collections of objects. We want
       # the raw objects to be cloned so we bypass load by directly setting the attributes hash.
@@ -288,9 +293,11 @@ module Fera
       if matcher.present?
         attribute_name = matcher[1]
         return super if attribute_name.blank?
+
         attribute_name = "is_#{ attribute_name }" unless attribute_name =~ /^is_/
         return super unless known_attribute?(attribute_name.to_s)
-        return !!(send(attribute_name.to_sym).presence)
+
+        return !!send(attribute_name.to_sym).presence
       end
 
       super
@@ -301,6 +308,7 @@ module Fera
       if matcher.present?
         attribute_name = matcher[1]
         return super if attribute_name.blank?
+
         attribute_name = "is_#{ attribute_name }" unless attribute_name =~ /^is_/
         return true if known_attribute?(attribute_name)
       end
@@ -312,7 +320,7 @@ module Fera
       known_attributes.map(&:to_s).include?(attribute_name.to_s)
     end
 
-    def set_last_response(result)
+    def set_last_response(result) # rubocop:disable Naming/AccessorMethodName
       response = if result.is_a?(StandardError)
                    @last_response_exception = result
                    @last_response_exception.response
@@ -370,5 +378,9 @@ module Fera
       sub_fields = sub_fields.drop(1)
       changed_attributes[sub_key] = values.map { |value| clone_selected_fields(value, sub_fields) }
     end
+
+    def debug(message)
+      puts "[Fera-Api] #{ message }" if ::Fera::Api.debug_mode?
+    end
   end
 end

data/lib/fera/models/collection.rb

@@ -5,7 +5,7 @@ module Fera
     attr_reader :result_count, :total_count, :page, :total_pages, :page_size, :offset, :limit
 
     def initialize(parsed = {})
-      @elements = parsed['data']
+      super(parsed['data'])
       @result_count = parsed['result_count']
       @total_count = parsed['total_count']
 

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

@@ -10,8 +10,8 @@ module Fera
 
     def customer=(customer)
       if customer.is_a?(Customer)
-        @customer = customer
-        self.attributes['customer_id'] = customer.id
+        @customer                               = customer
+        self.attributes['customer_id']          = customer.id
         self.attributes['external_customer_id'] = customer.try(:external_id)
         self.attributes.delete('customer')
       elsif customer.is_a?(Hash)
@@ -32,9 +32,6 @@ module Fera
         @customer = Customer.new(customer, customer_id.present?)
         self.attributes.delete('customer')
       end
-
-
-      @customer
     end
 
     def customer_id=(new_id)
@@ -62,8 +59,6 @@ module Fera
         Customer.find(customer_id)
       elsif attributes.key?('external_customer_id') && external_customer_id.present?
         Customer.find(external_customer_id)
-      else
-        nil
       end
     end
   end

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

@@ -9,29 +9,28 @@ module Fera
     end
 
     def order=(order)
-      order_id = if order.is_a?(Order)
-                     order.id
-                   else
-                     order.try(:with_indifferent_access).try(:[], :id)
-                   end
+      order_id          = if order.is_a?(Order)
+                            order.id
+                          else
+                            order.try(:with_indifferent_access).try(:[], :id)
+                          end
       external_order_id = if order.is_a?(Order)
-                              order.external_id
-                            else
-                              order.try(:with_indifferent_access).try(:[], :external_id)
-                            end
-      @order = if order.is_a?(Order)
-                   order
-                 else
-                   Order.new(order, order_id.present?)
-                 end
+                            order.external_id
+                          else
+                            order.try(:with_indifferent_access).try(:[], :external_id)
+                          end
+      @order            = if order.is_a?(Order)
+                            order
+                          else
+                            Order.new(order, order_id.present?)
+                          end
       self.attributes['order_id'] = order_id
       self.attributes['external_order_id'] = external_order_id
       self.attributes.delete('order')
-      @order
     end
 
     def order_id=(new_id)
-      return new_id if order_id == new_id
+      return if order_id == new_id
 
       if new_id.nil?
         reset_order_instance_assoc
@@ -41,7 +40,7 @@ module Fera
     end
 
     def external_order_id=(new_id)
-      return new_id if external_order_id == new_id
+      return if external_order_id == new_id
 
       if new_id.nil?
         reset_order_instance_assoc
@@ -78,10 +77,7 @@ module Fera
         Order.find(order_id)
       elsif attributes.key?('external_order_id') && external_order_id.present?
         Order.find(external_order_id)
-      else
-        nil
       end
     end
-
   end
 end

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

@@ -9,25 +9,24 @@ module Fera
     end
 
     def product=(product)
-      product_id = if product.is_a?(Product)
-                    product.id
-                  else
-                    product.try(:with_indifferent_access).try(:[], :id)
-                  end
+      product_id          = if product.is_a?(Product)
+                              product.id
+                            else
+                              product.try(:with_indifferent_access).try(:[], :id)
+                            end
       external_product_id = if product.is_a?(Product)
-                     product.external_id
-                   else
-                     product.try(:with_indifferent_access).try(:[], :external_id)
-                   end
-      @product = if product.is_a?(Product)
-                      product
-                    else
-                      Product.new(product, product_id.present?)
-                    end
+                              product.external_id
+                            else
+                              product.try(:with_indifferent_access).try(:[], :external_id)
+                            end
+      @product            = if product.is_a?(Product)
+                              product
+                            else
+                              Product.new(product, product_id.present?)
+                            end
       self.attributes['product_id'] = product_id
       self.attributes['external_product_id'] = external_product_id
       self.attributes.delete('product')
-      @product
     end
 
     def product
@@ -39,10 +38,7 @@ module Fera
         Product.find(product_id)
       elsif attributes.key?('external_product_id') && external_product_id.present?
         Product.find(external_product_id)
-      else
-        nil
       end
     end
-
   end
 end

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

@@ -10,18 +10,17 @@ module Fera
 
     def review=(review)
       review_id = if review.is_a?(Review)
-                        review.id
-                      else
-                        review.try(:with_indifferent_access).try(:[], :id)
-                      end
-      @review = if review.is_a?(Review)
-                      review
-                    else
-                      Review.new(review, review_id.present?)
-                    end
+                    review.id
+                  else
+                    review.try(:with_indifferent_access).try(:[], :id)
+                  end
+      @review   = if review.is_a?(Review)
+                    review
+                  else
+                    Review.new(review, review_id.present?)
+                  end
       self.attributes['review_id'] = review_id
       self.attributes.delete('review')
-      @review
     end
 
     def review
@@ -31,10 +30,7 @@ module Fera
         Review.new(attributes['review'], true)
       elsif attributes.key?('review_id') && review_id.present?
         Review.find(review_id)
-      else
-        nil
       end
     end
-
   end
 end