vindi-hermes 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cfeffedc8df5f4cfd1d2fc38730c15185bb9c454a30c8e9fbe3308168a7cda6f
-  data.tar.gz: 707dad5195dc739dc23a46953198bd084be58cbb0a95faef053231f39c9f264e
+  metadata.gz: 0f54cd4844598eda33e4bb1aa7d8a7a9a6dd9b5997e1442510642dc656e4ed70
+  data.tar.gz: 4a043d2c49f7633650693bcc16b0b400677ed9890ea014e3f6bfbe187d74b6aa
 SHA512:
-  metadata.gz: 985bbbda160a2c67ae61896cdff47d4ab4e05284e3661cf3498821aa84223c920fc9c4fac6d204b513a7260fc03ff62de877e6f664d71ddf025a5c6d4c5d55b4
-  data.tar.gz: 6b8bf90607a8ba997ddb4273c7c24c07028fdafc46e1668be3750a89d8c2d6a7e0d318982f2c38bd3fc2861911ba4db6f83b7e673da7f78f851947a718db33b9
+  metadata.gz: f82e4c48114f55a6bb2cdeb319e400c0a0d3238df5455bf00e4fda5e60615afd4889a9d65b57aa0014f998d248190bd83e67e5aa420f669df12677910f3581d3
+  data.tar.gz: 400a9f6d5254697234b6c69350e3824b8ee58d1b3bd432de652aff9a4705feffdabcfc15a949672262743d79153ac50a12d3b55966529886321c6d4423f39f15

data/.gitignore

@@ -6,3 +6,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+.env

data/.tool-versions

@@ -0,0 +1 @@
+ruby 2.7.3

data/Gemfile

@@ -6,4 +6,15 @@ source "https://rubygems.org"
 gemspec
 
 gem "rake", "~> 13.0"
-gem "rubocop"
+
+group :development do
+  gem "httplog"
+  gem "pry-byebug"
+  gem "rubocop"
+end
+
+group :test do
+  gem "rspec"
+  gem "vcr"
+  gem "webmock"
+end

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    vindi-hermes (0.0.1)
+    vindi-hermes (0.0.2)
       faraday (~> 1.4)
       faraday_middleware (~> 1.0)
       her (~> 1.1)
@@ -17,8 +17,14 @@ GEM
       minitest (>= 5.1)
       tzinfo (~> 2.0)
       zeitwerk (~> 2.3)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
     ast (2.4.2)
+    byebug (11.1.3)
+    coderay (1.1.3)
     concurrent-ruby (1.1.8)
+    crack (0.4.5)
+      rexml
     diff-lcs (1.4.4)
     faraday (1.4.2)
       faraday-em_http (~> 1.0)
@@ -35,6 +41,7 @@ GEM
     faraday-net_http_persistent (1.1.0)
     faraday_middleware (1.0.0)
       faraday (~> 1.0)
+    hashdiff (1.0.1)
     her (1.1.1)
       activemodel (>= 4.2.1)
       faraday (>= 0.8)
@@ -44,12 +51,20 @@ GEM
       rainbow (>= 2.0.0)
     i18n (1.8.10)
       concurrent-ruby (~> 1.0)
+    method_source (1.0.0)
     minitest (5.14.4)
     multi_json (1.15.0)
     multipart-post (2.1.1)
     parallel (1.20.1)
     parser (3.0.1.1)
       ast (~> 2.4.1)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.9.0)
+      byebug (~> 11.0)
+      pry (~> 0.13.0)
+    public_suffix (4.0.6)
     rack (2.2.3)
     rainbow (3.0.0)
     rake (13.0.3)
@@ -84,6 +99,11 @@ GEM
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
     unicode-display_width (2.0.0)
+    vcr (6.0.0)
+    webmock (3.12.2)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
     zeitwerk (2.4.2)
 
 PLATFORMS
@@ -91,10 +111,13 @@ PLATFORMS
 
 DEPENDENCIES
   httplog
+  pry-byebug
   rake (~> 13.0)
-  rspec (~> 3.2)
+  rspec
   rubocop
+  vcr
   vindi-hermes!
+  webmock
 
 BUNDLED WITH
    2.2.17

data/README.md

@@ -1,4 +1,4 @@
-# **Vindi** **Her**mes - Let the god of trade help you
+# Vindi Hermes
 
 ActiveRecord-like way to interact with Vindi API
 
@@ -13,18 +13,15 @@ ActiveRecord-like way to interact with Vindi API
   *
     [Vindi - Official Gem](https://github.com/vindi/vindi-ruby)
 
-    > You may ask: Why create another if there is already one that's official?
-    > *And I'll tell you, **little grasshopper**: Because I think this one could be more beautiful.*
-    >
-    > And you also may ask: Why the hell is the doc in english when all those interested are from the big banana republic?
-    > *And my answer to you would be: You ask a lot of questions, huh?*
+    > You may ask: Why create another gem if there is already one that's official?
+    > *And I'll tell you, **little grasshopper**: Because MIT licenses are better than GPLv3.*
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'vindi-hermes'
+gem "vindi-hermes"
 ```
 
 And then execute:
@@ -43,9 +40,9 @@ Or install it yourself as:
 # config/initializers/vindi.rb
 Vindi.config do |c|
   c.sandbox = true # default is false
-  c.api_key = 'YOUR API KEY'
-  c.webhook_name = 'BASIC AUTH NAME'
-  c.webhook_password = 'BASIC AUTH PASSWORD'
+  c.api_key = "YOUR API KEY"
+  c.webhook_name = "BASIC AUTH NAME"
+  c.webhook_password = "BASIC AUTH PASSWORD"
 end
 ```
 
@@ -163,9 +160,9 @@ On your project
 ```ruby
 # config/initializers/vindi.rb
 Vindi.config do |c|
-  c.api_key = '123456'
-  c.webhook_name = 'vindi'
-  c.webhook_password = '123456'
+  c.api_key = "123456"
+  c.webhook_name = "vindi"
+  c.webhook_password = "123456"
 end
 
 # routes.rb

data/bin/console

@@ -8,8 +8,8 @@ require "vindi"
 # with your gem easier. You can also use a different console, if you like.
 
 # (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
+require "pry"
+Pry.start
 
-require "irb"
-IRB.start(__FILE__)
+# require "irb"
+# IRB.start(__FILE__)

data/lib/vindi.rb

@@ -6,11 +6,14 @@ require "her"
 
 require_relative "vindi/version"
 require_relative "vindi/rate_limit"
+
 require_relative "vindi/middleware/rate_limit_validation"
 require_relative "vindi/middleware/response_parser"
+
 require_relative "vindi/core_extensions/her_with_query_filter"
+require_relative "vindi/core_extensions/her_save_only_changed_attrs"
 
-module Vindi
+module Vindi # :nodoc:
   class Error < StandardError; end
 
   RESOURCE_MODELS = Dir[File.expand_path("vindi/models/**/*.rb", File.dirname(__FILE__))].freeze

data/lib/vindi/core_extensions/her_save_only_changed_attrs.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module CoreExtensions
+  # WARNING: monkey patch (https://github.com/remi/her/blob/master/lib/her/model/relation.rb#L34)
+  module HerSaveOnlyChangedAttrs
+    # Validate record before save and after the request
+    # put the errors in the right places.
+    #
+    # @example A subscription without a customer
+    #
+    #   @subscription = Vindi::Subscription.new.tap do |s|
+    #     s.plan_id = plan.id
+    #     s.payment_method_code = "credit_card"
+    #     s.save
+    #   end
+    #
+    #   @subscription.errors.full_messages # ["Customer can't be blank"]
+    #
+    # @example A subscription with invalid plan
+    #
+    #   @subscription = Vindi::Subscription.new.tap do |s|
+    #     s.customer_id = customer.id
+    #     s.plan_id = 1
+    #     s.payment_method_code = "credit_card"
+    #     s.save
+    #   end
+    #
+    #   @subscription.errors.full_messages # ["Plan nao encontrado"]
+    #
+    def save
+      if new?
+        super
+      else
+        save_current_changes
+      end
+
+      response_errors.any? && errors.clear && response_errors.each do |re|
+        errors.add re[:attribute], re[:type], message: re[:message]
+      end
+
+      return false if errors.any?
+
+      self
+    end
+
+    private
+
+    def save_current_changes
+      return self unless changed.any?
+
+      callback = new? ? :create : :update
+      method = self.class.method_for(callback)
+
+      run_callbacks :save do
+        run_callbacks callback do
+          self.class.request(filtered_changed_attributes.merge(_method: method, _path: request_path)) do |parsed_data, response|
+            load_from_parsed_data(parsed_data)
+            return false if !response.success? || @response_errors.any?
+            changes_applied
+          end
+        end
+      end
+
+      self
+    end
+
+    def filtered_changed_attributes
+      changes.transform_values(&:last)
+    end
+  end
+end
+
+Her::Model::ORM.prepend CoreExtensions::HerSaveOnlyChangedAttrs

data/lib/vindi/core_extensions/her_with_query_filter.rb

@@ -19,25 +19,27 @@ module CoreExtensions
       return self if params.blank? && !@_fetch.nil?
 
       clone.tap do |r|
-        default_params = extract_params params, r.params
-        query = params_to_query params, parse_query(r.params.fetch(:query, ""))
+        r.params = r.params.merge(params)
+
+        # Default params, as order and page number, will always be used.
+        default_params = extract_default_params r.params
+
+        # Query filters is joined into a single param called :query.
+        query = [r.params.delete(:query), params_to_query(r.params)].compact.join " "
+
+        r.params = { query: query }.merge(default_params)
 
-        r.params = r.params.merge default_params.merge(query: query)
         r.clear_fetch_cache!
       end
     end
 
     private
 
-    def parse_query(query)
-      CGI.parse(query).transform_values(&:first)
-    end
-
-    def extract_params(new_ones, old_ones)
-      page        = new_ones.delete(:page)        || old_ones.delete(:page)       || 1
-      per_page    = new_ones.delete(:per_page)    || old_ones.delete(:per_page)   || 25
-      sort_by     = new_ones.delete(:sort_by)     || old_ones.delete(:sort_by)    || :created_at
-      sort_order  = new_ones.delete(:sort_order)  || old_ones.delete(:sort_order) || :desc
+    def extract_default_params(params)
+      page        = params.delete(:page)        || 1
+      per_page    = params.delete(:per_page)    || 25
+      sort_by     = params.delete(:sort_by)     || :created_at
+      sort_order  = params.delete(:sort_order)  || :desc
 
       {
         page: page,
@@ -47,8 +49,8 @@ module CoreExtensions
       }.delete_if { |_, v| v.nil? }
     end
 
-    def params_to_query(params, query)
-      params.merge(query).map do |key, value|
+    def params_to_query(params)
+      params.map do |key, value|
         case key
         when :contains  then value.map { |k, v| "#{k}:#{v}" }.last
         when :gt        then value.map { |k, v| "#{k}>#{v}" }.last

data/lib/vindi/models/model.rb

@@ -31,40 +31,14 @@ module Vindi
 
     before_validation
 
-    # Validate record before save and after the request
-    # put the errors in the right places.
+    # Archive a record.
     #
-    # @example A subscription without a customer
+    # @example Archive a customer
     #
-    #   @subscription = Vindi::Subscription.new.tap do |s|
-    #     s.plan_id = plan.id
-    #     s.payment_method_code = "credit_card"
-    #     s.save
-    #   end
+    #   Vindi::Customer.find_by(email: "sarumanthewhite@middlearth.io").archive!
     #
-    #   @subscription.errors.full_messages # ["Customer can't be blank"]
-    #
-    # @example A subscription with invalid plan
-    #
-    #   @subscription = Vindi::Subscription.new.tap do |s|
-    #     s.customer_id = customer.id
-    #     s.plan_id = 1
-    #     s.payment_method_code = "credit_card"
-    #     s.save
-    #   end
-    #
-    #   @subscription.errors.full_messages # ["Plan nao encontrado"]
-    #
-    def save
-      super
-
-      response_errors.any? && errors.clear && response_errors.each do |re|
-        errors.add re[:attribute], re[:type], message: re[:message]
-      end
-
-      return false if errors.any?
-
-      self
+    def archive!
+      destroy
     end
 
     # @private

data/lib/vindi/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Vindi
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/vindi-hermes.gemspec

@@ -26,7 +26,4 @@ Gem::Specification.new do |spec|
   spec.add_dependency "faraday", "~> 1.4"
   spec.add_dependency "faraday_middleware", "~> 1.0"
   spec.add_dependency "her", "~> 1.1"
-
-  spec.add_development_dependency "httplog"
-  spec.add_development_dependency "rspec", "~> 3.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vindi-hermes
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Wedson Lima
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-01 00:00:00.000000000 Z
+date: 2021-06-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -52,34 +52,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.1'
-- !ruby/object:Gem::Dependency
-  name: httplog
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.2'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.2'
 description: ActiveRecord-like way to interact with Vindi API
 email:
 - wedson.sousa.lima@gmail.com
@@ -89,6 +61,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rubocop.yml"
+- ".tool-versions"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -99,6 +72,7 @@ files:
 - bin/console
 - bin/setup
 - lib/vindi.rb
+- lib/vindi/core_extensions/her_save_only_changed_attrs.rb
 - lib/vindi/core_extensions/her_with_query_filter.rb
 - lib/vindi/middleware/rate_limit_validation.rb
 - lib/vindi/middleware/response_parser.rb
@@ -143,7 +117,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Vindi API - Let the god of trade help you