ledger_sync 1.5.1 → 1.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: efcf3cc57a3f68ad9612fde0eb59ac3e06acd8d644a579397c2c1a17046d4be1
-  data.tar.gz: db61863e31a0fc7004e020b1c0672b52a3de117edd7b57a5ff874edf6505e20c
+  metadata.gz: f2b28cb8266fdd627c4c7b19166f0fae7c65742556662e5fdb4150aa6d73a297
+  data.tar.gz: 5184d055660ead3e05e63dc4e3ad6bff063d79af1e9571311d62ca1ad67acfab
 SHA512:
-  metadata.gz: 777f81a8164db6a0e8d82081bcd70d01bdf34542ace2ae494fa475e632201df1e23211308d6df18f97eab5bf49fe1743bcce52bfc44b0e2aebf8d468ce3b8e21
-  data.tar.gz: 3398a7232feb2f4659061705f7aefe960fcf2459a84f156d6ab86f2be8967f0a28c6a0035b4688780dcca99d6937a23b1f0de38bffc0f2e1031c577056fbcef6
+  metadata.gz: f937d553df677636512d4e8345b2c188f0533a9cc7e8f74911b90b258646c206ed9f5c3172f422a4c31a32724d9d58086aa362ada77526f113cb733fe7554ad7
+  data.tar.gz: 267bf6cefa55aa03de38086666917e852d865e7045c68bc923648fd2c237e26fdf71a1a700bba239c4afa15430283b6748ed8b61b334b923d56c99c43c5f6c3f

data/Gemfile.lock

@@ -1,10 +1,9 @@
 PATH
   remote: .
   specs:
-    ledger_sync (1.5.1)
+    ledger_sync (1.5.2)
       activemodel
       colorize
-      coveralls (~> 0.8.23)
       dotenv (~> 2.7.6)
       dry-schema (~> 1.5.4)
       dry-validation (~> 1.5.6)
@@ -265,6 +264,7 @@ DEPENDENCIES
   bump (~> 0.9.0)
   bundler (~> 2.1)
   byebug
+  coveralls (~> 0.8.23)
   factory_bot (~> 6.1.0)
   jekyll (~> 3.8.4)
   jekyll-menus (~> 0.6.0)

data/ledger_sync.gemspec

@@ -34,6 +34,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency('bump', '~> 0.9.0')
   spec.add_development_dependency('bundler', '~> 2.1')
   spec.add_development_dependency('byebug', '>= 0')
+  spec.add_development_dependency('coveralls', '~> 0.8.23')
   spec.add_development_dependency('factory_bot', '~> 6.1.0')
   spec.add_development_dependency('jekyll', '~> 3.8.4')
   spec.add_development_dependency('jekyll-menus', '~> 0.6.0')
@@ -47,7 +48,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency('webmock', '>= 0')
   spec.add_runtime_dependency('activemodel', '>= 0')
   spec.add_runtime_dependency('colorize', '>= 0')
-  spec.add_runtime_dependency('coveralls', '~> 0.8.23')
   spec.add_runtime_dependency('dotenv', '~> 2.7.6')
   spec.add_runtime_dependency('dry-schema', '~> 1.5.4')
   spec.add_runtime_dependency('dry-validation', '~> 1.5.6')

data/lib/ledger_sync/test/support/operation_shared_examples.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+RSpec.shared_examples 'a valid operation' do
+  it 'is valid' do
+    instance = described_class.new(resource: resource, client: client)
+    if ENV.fetch('DEBUG', false) && !instance.valid?
+      pd instance.errors
+      byebug if ENV['DEBUG'] # rubocop:disable Lint/Debugger
+    end
+    expect(instance).to be_valid
+  end
+end
+
+RSpec.shared_examples 'a successful operation' do |stubs: []|
+  before do
+    stubs = Array(stubs)
+    stubs.each do |stub|
+      if stub.is_a?(Array)
+        send(*stub)
+      else
+        send(stub)
+      end
+    end
+  end
+
+  it 'is successful' do
+    result = described_class.new(resource: resource, client: client).perform
+    byebug if ENV.fetch('DEBUG', false) && result.failure? # rubocop:disable Lint/Debugger
+    expect(result).to be_a(LedgerSync::OperationResult::Success)
+  end
+end
+
+RSpec.shared_examples 'an operation' do
+  it_behaves_like 'a valid operation'
+end

data/lib/ledger_sync/test/support/qa/ledger_helpers.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module LedgerSync
+  module Test
+    module QA
+      module LedgerHelpers
+        def create_resource_for(*args)
+          create_result_for(*args).raise_if_error.resource
+        end
+
+        def create_result_for(client:, resource:)
+          result_for(
+            client: client,
+            method: :create,
+            resource: resource
+          )
+        end
+
+        def delete_resource_for(*args)
+          delete_result_for(*args).raise_if_error.resource
+        end
+
+        def delete_result_for(client:, resource:)
+          result_for(
+            client: client,
+            method: :delete,
+            resource: resource
+          )
+        end
+
+        def find_resource_for(*args)
+          find_result_for(*args).raise_if_error.resource
+        end
+
+        def find_result_for(client:, resource:)
+          result_for(
+            client: client,
+            method: :find,
+            resource: resource
+          )
+        end
+
+        def result_for(client:, method:, resource:)
+          client.operation_for(
+            method: method,
+            resource: resource
+          ).perform
+        end
+
+        def update_resource_for(*args)
+          update_result_for(*args).raise_if_error.resource
+        end
+
+        def update_result_for(client:, resource:)
+          result_for(
+            client: client,
+            method: :update,
+            resource: resource
+          )
+        end
+      end
+    end
+  end
+end

data/lib/ledger_sync/test/support/qa/ledger_support_setup.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+def setup_client_qa_support(*clients, keyed: false)
+  clients.each do |client|
+    key = client.config.root_key
+
+    qa_support "#{key}_helpers"
+    helpers_module  = Object.const_get("QA::#{client.base_module.name.split('::').last}Helpers")
+    env_key         = "#{key}_qa".upcase
+
+    RSpec.configure do |config|
+      if keyed
+        config.include helpers_module, qa: true, client: key
+      else
+        config.include helpers_module, qa: true
+      end
+
+      config.around(:each, qa: true) do |example|
+        if ENV.fetch(env_key, nil) == '1'
+          example.run
+        else
+          skip "Set #{env_key}=1 to run #{key} QA tests"
+        end
+      end
+    end
+  end
+end

data/lib/ledger_sync/test/support/qa/shared_examples.rb

@@ -0,0 +1,153 @@
+# frozen_string_literal: true
+
+RSpec.shared_examples 'a create' do |delete: true|
+  it do
+    result = create_result_for(
+      client: client,
+      resource: resource
+    )
+
+    byebug if result.failure? # rubocop:disable Lint/Debugger
+
+    expect(result).to be_success
+
+    if delete
+      delete_result_for(
+        client: client,
+        resource: result.resource
+      ).raise_if_error
+    end
+  end
+end
+
+RSpec.shared_examples 'a delete' do
+  it do
+    result = create_result_for(
+      client: client,
+      resource: resource
+    ).raise_if_error
+
+    resource = result.resource
+
+    result = delete_result_for(
+      client: client,
+      resource: resource
+    )
+
+    expect(result).to be_success
+
+    result = delete_result_for(
+      client: client,
+      resource: resource
+    )
+
+    expect(result).to be_failure
+  end
+end
+
+RSpec.shared_examples 'a find' do |delete: true|
+  it do
+    result = create_result_for(
+      client: client,
+      resource: resource
+    )
+
+    byebug if result.failure? # rubocop:disable Lint/Debugger
+    result.raise_if_error
+    expect(result).to be_success
+    resource = result.resource
+
+    begin
+      result = find_result_for(
+        client: client,
+        resource: resource
+      )
+
+      expect(result).to be_success
+    ensure
+      if delete
+        # Be sure to delete resource or raise an exception if this fails
+        delete_result_for(
+          client: client,
+          resource: resource
+        ).raise_if_error
+      end
+    end
+  end
+end
+
+RSpec.shared_examples 'a find only' do
+  it do
+    result = find_result_for(
+      client: client,
+      resource: resource
+    )
+
+    expect(result).to be_success
+  end
+end
+
+RSpec.shared_examples 'an update' do |delete: true|
+  it do
+    result = create_result_for(
+      client: client,
+      resource: resource
+    ).raise_if_error
+
+    expect(result).to be_success
+    resource = result.resource
+
+    begin
+      # Ensure values are currently not the same as the updates
+      attribute_updates.each do |k, v|
+        expect(resource.send(k)).not_to eq(v)
+      end
+
+      resource.assign_attributes(attribute_updates)
+      result = update_result_for(
+        client: client,
+        resource: resource
+      )
+
+      expect(result).to be_success
+      resource = result.resource
+
+      # Ensure values are updated
+      attribute_updates.each do |k, v|
+        expect(resource.send(k)).to eq(v)
+      end
+
+      result = find_result_for(
+        client: client,
+        resource: resource.class.new(
+          ledger_id: resource.ledger_id
+        )
+      ).raise_if_error
+
+      expect(result).to be_success
+      resource = result.resource
+
+      # Ensure values are updated after raw find
+      attribute_updates.each do |k, v|
+        expect(resource.send(k)).to eq(v)
+      end
+    ensure
+      if delete
+        delete_result_for(
+          client: client,
+          resource: resource
+        ).raise_if_error
+      end
+    end
+  end
+end
+
+RSpec.shared_examples 'a searcher' do
+  it do
+    result = client.searcher_for(resource_type: resource.class.resource_module_str).search
+
+    byebug if result.failure? # rubocop:disable Lint/Debugger
+
+    expect(result).to be_success
+  end
+end

data/lib/ledger_sync/test/support/record_collection.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module LedgerSync
+  module Test
+    class Record
+      attr_reader :hash, :path, :record
+
+      def initialize(args = {})
+        @hash = args.fetch(:hash)
+        @path = args.fetch(:path)
+        @record = args.fetch(:record)
+      end
+
+      def id
+        @id ||= hash.fetch('id', nil)
+      end
+    end
+
+    class RecordCollection
+      attr_reader :dir, :record_class, :records
+
+      def initialize(args = {})
+        @dir = args.fetch(:dir)
+        @record_class = args.fetch(:record_class, Record)
+
+        @records = {}
+
+        # Process json files
+        Gem.find_files(File.join(dir, '*.json')).map do |file_path|
+          record = File.basename(file_path, '.json').to_sym
+          @records[record] = record_class.new(
+            hash: JSON.parse(File.open(file_path).read),
+            path: file_path,
+            record: record
+          )
+          self.class.define_method(record) do
+            records[record]
+          end
+        end
+
+        # Process directories
+        Dir.chdir(dir) do
+          Dir.glob('*').select { |f| File.directory? f }.each do |sub_dir|
+            sub_dir_path = File.join(dir, sub_dir)
+            next if Gem.find_files(File.join(sub_dir_path, '**/*.json')).empty?
+
+            @records[sub_dir.to_sym] = RecordCollection.new(dir: sub_dir_path)
+            self.class.define_method(sub_dir) do
+              records[sub_dir.to_sym]
+            end
+          end
+        end
+      end
+
+      def all
+        @all ||= begin
+          ret = {}
+          records.each do |k, v|
+            if v.is_a?(self.class)
+              v.all.each do |sub_k, sub_v|
+                ret[[k, sub_k].join('/').to_s] = sub_v
+              end
+            else
+              ret[k.to_s] = v
+            end
+          end
+          ret
+        end
+      end
+    end
+  end
+end

data/lib/ledger_sync/test/support/test_ledger_helpers.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module TestLedgerHelpers
+  # Ledger
+  def test_ledger_module
+    LedgerSync.ledgers.test_ledger.base_module
+  end
+
+  def test_ledger_client
+    LedgerSync.ledgers.test_ledger.new(
+      api_key: 'api_key'
+    )
+  end
+end

data/lib/ledger_sync/test/support/webmock_helpers.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+def stubs_and_times
+  @stubs_and_times ||= []
+end
+
+def stubs_and_times_reset
+  @stubs_and_times = []
+end
+
+module WebMock
+  module API
+    # Overwrite the original stub_request method to enforce we explicitly say
+    # how many times we expect a request to be called
+    def stub_request(*args, times: 1)
+      ret = WebMock::StubRegistry.instance
+                                 .register_request_stub(WebMock::RequestStub.new(*args))
+      stubs_and_times << [ret, times] unless times.nil?
+      ret
+    end
+  end
+end
+
+RSpec.configure do |config|
+  config.before { WebMock.reset! }
+  config.around(qa: true) do |example|
+    WebMock.disable!
+    example.run
+  ensure
+    WebMock.enable!
+  end
+  config.after do
+    stubs_and_times.each do |stub, times|
+      expect(stub).to have_been_requested.times(times)
+    end
+    stubs_and_times_reset
+  end
+end

data/lib/ledger_sync/test/support.rb

@@ -2,19 +2,25 @@
 
 def support(*paths)
   paths.each do |path|
-    require File.join(LedgerSync.root, 'spec/support/', path.to_s)
+    require File.join('support/', path.to_s)
+  end
+end
+
+def qa_support(*paths)
+  paths.each do |path|
+    require File.join('qa/support/', path.to_s)
   end
 end
 
 def core_support(*paths)
   paths.each do |path|
-    require File.join(LedgerSync.root, 'lib/ledger_sync/test/support/', path.to_s)
+    require File.join('ledger_sync/test/support/', path.to_s)
   end
 end
 
-def qa_support(*paths)
+def core_qa_support(*paths)
   paths.each do |path|
-    require File.join(LedgerSync.root, 'spec/qa/support/', path.to_s)
+    require File.join('ledger_sync/test/support/qa/', path.to_s)
   end
 end
 
@@ -25,7 +31,7 @@ module LedgerSync
         require 'webmock/rspec'
         require 'simplecov'
         require 'coveralls'
-        Coveralls.wear!
+        Coveralls.wear!('rails')
 
         SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter.new(
           [
@@ -49,8 +55,10 @@ module LedgerSync
 
         paths_to_require.each { |e| require e.to_s }
 
-        # Include test adaptor
-        core_support 'test_ledger/config'
+        core_support 'webmock_helpers'
+        core_support 'record_collection'
+
+        core_support 'qa/ledger_support_setup'
 
         core_support :factory_bot
 

data/lib/ledger_sync/version.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module LedgerSync
-  VERSION = '1.5.1'
+  VERSION = '1.5.2'
 
   def self.version
     if !ENV['TRAVIS'] || ENV.fetch('TRAVIS_TAG', '') != ''

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ledger_sync
 version: !ruby/object:Gem::Version
-  version: 1.5.1
+  version: 1.5.2
 platform: ruby
 authors:
 - Ryan Jackson
@@ -66,6 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.23
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.23
 - !ruby/object:Gem::Dependency
   name: factory_bot
   requirement: !ruby/object:Gem::Requirement
@@ -248,20 +262,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: coveralls
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.8.23
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.8.23
 - !ruby/object:Gem::Dependency
   name: dotenv
   requirement: !ruby/object:Gem::Requirement
@@ -1065,6 +1065,11 @@ files:
 - lib/ledger_sync/serializer.rb
 - lib/ledger_sync/test/support.rb
 - lib/ledger_sync/test/support/factory_bot.rb
+- lib/ledger_sync/test/support/operation_shared_examples.rb
+- lib/ledger_sync/test/support/qa/ledger_helpers.rb
+- lib/ledger_sync/test/support/qa/ledger_support_setup.rb
+- lib/ledger_sync/test/support/qa/shared_examples.rb
+- lib/ledger_sync/test/support/record_collection.rb
 - lib/ledger_sync/test/support/test_ledger/client.rb
 - lib/ledger_sync/test/support/test_ledger/config.rb
 - lib/ledger_sync/test/support/test_ledger/customer/deserializer.rb
@@ -1094,6 +1099,8 @@ files:
 - lib/ledger_sync/test/support/test_ledger/webhook.rb
 - lib/ledger_sync/test/support/test_ledger/webhook_event.rb
 - lib/ledger_sync/test/support/test_ledger/webhook_notification.rb
+- lib/ledger_sync/test/support/test_ledger_helpers.rb
+- lib/ledger_sync/test/support/webmock_helpers.rb
 - lib/ledger_sync/type/boolean.rb
 - lib/ledger_sync/type/date.rb
 - lib/ledger_sync/type/float.rb