mergent 0.1.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 991390648edd146ed10b823a1a47c2c7af7b480cdbf89600018f74d1430f878b
-  data.tar.gz: cc42af168a1dc2ea25622a24b200cee773cb8ebe54197215bf3e5bbe30b4fff1
+  metadata.gz: 11e9b11314fa0fe8f575245b4e412d1cfdad25a6ed3d8ed9c752e70e0dce3f8a
+  data.tar.gz: 131a29cc73047bf2eb06850c820d5e4c152510613286826fbfeb9ac96d2c9b72
 SHA512:
-  metadata.gz: c12851c47f643729e3f8f2d1a90266bbf71a636ca76c2b51f633886efe62c71f9c0492968842230846f8e78d59877233a17f5c9fad8e461590a9528ab05c4eaa
-  data.tar.gz: 91179f7fbb9a5cfda2e28e1d87641d98e28b17dac8df398a32a89d18ce354f164adb5848120459479db3157e0d83d0e23340eeebe87d4f5dd6700ec41ffee632
+  metadata.gz: fb4fd8c6f5ed38a308d98916a7f7c530d6e88ba15e3c30b2e7094bea68f3b68ca942735c1a082afd3185078a7f9c9dbfb516c4ea6474045d4eecdc2f0a53fff3
+  data.tar.gz: 3cf6df4e8e643fa9517052be9b1f047c1427a76d07df1ade6d3d594daaa344b79891e5de97e9a79453e9ab1b247505b6d645cd011dc110aa2bc6a84b30b0929b

data/.rubocop.yml

@@ -22,9 +22,6 @@ RSpec/MultipleExpectations:
 Style/Documentation:
   Enabled: false
 
-Style/FrozenStringLiteralComment:
-  Enabled: false
-
 Style/StringLiterals:
   EnforcedStyle: double_quotes
 

data/.ruby-version

@@ -0,0 +1 @@
+ruby-3.0.2

data/CHANGELOG.md

@@ -1,5 +1,23 @@
 ## [Unreleased]
 
+## [0.2.1] - 2022-01-20
+
+- Add `Mergent::RequestValidator` to validate that webhooks came from Mergent's API
+
+## [0.2.0] - 2022-01-20
+
+- Add `Mergent::RequestValidator` to validate that webhooks came from Mergent's API
+
+## [0.1.2] - 2022-1-13
+
+- Define explicit methods in `Mergent::Task`, to allow for use of verifying doubles when testing against them.
+- Remove deprecated `cron` method definition
+
+## [0.1.1] - 2021-12-21
+
+- Define explicit methods in `Mergent::Task`, to allow for use of verifying doubles when testing against them.
+- Update summary and description for RubyGems.org
+
 ## [0.1.0] - 2021-11-21
 
 - Initial release

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source "https://rubygems.org"
 
 gemspec

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    mergent (0.1.0)
+    mergent (0.2.1)
 
 GEM
   remote: https://rubygems.org/
@@ -11,15 +11,15 @@ GEM
     ast (2.4.2)
     crack (0.4.5)
       rexml
-    diff-lcs (1.4.4)
+    diff-lcs (1.5.0)
     hashdiff (1.0.1)
     parallel (1.21.0)
-    parser (3.0.2.0)
+    parser (3.1.0.0)
       ast (~> 2.4.1)
     public_suffix (4.0.6)
-    rainbow (3.0.0)
+    rainbow (3.1.1)
     rake (13.0.6)
-    regexp_parser (2.1.1)
+    regexp_parser (2.2.0)
     rexml (3.2.5)
     rspec (3.10.0)
       rspec-core (~> 3.10.0)
@@ -27,30 +27,30 @@ GEM
       rspec-mocks (~> 3.10.0)
     rspec-core (3.10.1)
       rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.1)
+    rspec-expectations (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
     rspec-mocks (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
-    rspec-support (3.10.2)
-    rubocop (1.22.3)
+    rspec-support (3.10.3)
+    rubocop (1.24.1)
       parallel (~> 1.10)
       parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml
-      rubocop-ast (>= 1.12.0, < 2.0)
+      rubocop-ast (>= 1.15.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.12.0)
+    rubocop-ast (1.15.1)
       parser (>= 3.0.1.1)
-    rubocop-performance (1.12.0)
+    rubocop-performance (1.13.2)
       rubocop (>= 1.7.0, < 2.0)
       rubocop-ast (>= 0.4.0)
     rubocop-rake (0.6.0)
       rubocop (~> 1.0)
-    rubocop-rspec (2.5.0)
+    rubocop-rspec (2.7.0)
       rubocop (~> 1.19)
     ruby-progressbar (1.11.0)
     unicode-display_width (2.1.0)
@@ -73,4 +73,4 @@ DEPENDENCIES
   webmock
 
 BUNDLED WITH
-   2.2.31
+   2.3.4

data/README.md

@@ -1,4 +1,7 @@
-# Mergent
+# Mergent Ruby Library
+
+[![Gem Version](https://badge.fury.io/rb/mergent.svg)](https://badge.fury.io/rb/mergent)
+[![CI](https://github.com/mergentlabs/mergent-ruby/actions/workflows/ci.yml/badge.svg)](https://github.com/mergentlabs/mergent-ruby/actions/workflows/ci.yml)
 
 The Mergent Ruby library provides convenient access to the Mergent API from
 applications written in the Ruby language.
@@ -44,10 +47,11 @@ After checking out the repo, run `bundle` to install dependencies. Then, run
 `rake spec` to run the tests.
 
 To install this gem onto your local machine, run `bundle exec rake install`.
-To release a new version, update the version number in `version.rb`, and then
-run `bundle exec rake release`, which will create a git tag for the version,
-push git commits and the created tag, and push the `.gem` file to
-[rubygems.org](https://rubygems.org).
+
+To release a new version, update the changelog, bump the version number in
+`version.rb`, commit that change, and then run `bundle exec rake release`, which
+will create a git tag for the version, push git commits and the created tag, and
+push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 

data/lib/mergent/client.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 require "net/http"
 require "json"
 
 module Mergent
   class Client
     def self.post(resource, params) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
-      uri = URI("https://api.mergent.co/v1/#{resource}")
+      uri = URI("#{Mergent.endpoint}/#{resource}")
       headers = {
         Authorization: "Bearer #{Mergent.api_key}",
         "Content-Type": "application/json"
@@ -13,22 +15,32 @@ module Mergent
       request.body = params.to_json
 
       https = Net::HTTP.new(uri.host, uri.port)
-      https.use_ssl = true
+      https.use_ssl = Mergent.endpoint.start_with?("https")
       response = https.request(request)
 
       case response
       when Net::HTTPSuccess
-        JSON.parse(response.read_body, object_class: Mergent::Object)
+        JSON.parse(response.read_body)
       else
         begin
           body = JSON.parse(response.read_body)
         rescue JSON::ParserError
           body = {}
         end
-        raise Mergent::Error, body["message"]
+        raise Mergent::Error, error_message(body)
       end
     rescue EOFError, Errno::ECONNREFUSED, Errno::ECONNRESET, Errno::EHOSTUNREACH, Errno::ETIMEDOUT, SocketError
       raise Mergent::ConnectionError
     end
+
+    private
+
+    def self.error_message(body)
+      breakdown = body.fetch("errors", []).map { |error| error.fetch("message", nil) }.compact.join(", ")
+      msg = body["message"]
+      msg << " - #{breakdown}" unless breakdown.empty?
+      msg
+    end
+    private_class_method :error_message
   end
 end

data/lib/mergent/errors.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Mergent
   class Error < StandardError; end
 

data/lib/mergent/object.rb

@@ -1,3 +1,11 @@
+# frozen_string_literal: true
+
 module Mergent
-  class Object < OpenStruct; end
+  class Object
+    attr_reader :_data
+
+    def initialize(data = {})
+      @_data = data.transform_keys(&:to_sym)
+    end
+  end
 end

data/lib/mergent/request_validator.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Mergent
+  class RequestValidator
+    def initialize(api_key)
+      @api_key = api_key || Mergent.api_key
+    end
+
+    def build_signature_for(body)
+      digest = OpenSSL::Digest.new("sha1")
+      Base64.strict_encode64(OpenSSL::HMAC.digest(digest, @api_key, body || ""))
+    end
+
+    def valid_signature?(body, signature)
+      build_signature_for(body) == signature
+    end
+  end
+end

data/lib/mergent/task.rb

@@ -1,11 +1,21 @@
+# frozen_string_literal: true
+
 require_relative "client"
 require_relative "object"
 
 module Mergent
   class Task < Mergent::Object
+    ATTRS = %i[name description status request scheduled_for created_at].freeze
+
+    ATTRS.each do |name|
+      define_method(name) do
+        @_data[name]
+      end
+    end
+
     def self.create(params = {})
-      object = Client.post("tasks", params)
-      new(object)
+      data = Client.post("tasks", params)
+      new(data)
     end
   end
 end

data/lib/mergent/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Mergent
-  VERSION = "0.1.0".freeze
+  VERSION = "0.2.1"
 end

data/lib/mergent.rb

@@ -1,9 +1,16 @@
+# frozen_string_literal: true
+
 require_relative "mergent/errors"
+require_relative "mergent/request_validator"
 require_relative "mergent/task"
 require_relative "mergent/version"
 
 module Mergent
+  ENDPOINT = "https://api.mergent.co/v1"
+
   class << self
-    attr_accessor :api_key
+    attr_accessor :api_key, :endpoint
   end
 end
+
+Mergent.endpoint = Mergent::ENDPOINT

data/mergent.gemspec

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative "lib/mergent/version"
 
 Gem::Specification.new do |spec|
@@ -6,15 +8,16 @@ Gem::Specification.new do |spec|
   spec.author = "Mergent"
   spec.email = "support@mergent.co"
 
-  spec.summary = "Ruby bindings for the Mergent API"
-  spec.description = "See https://mergent.co for details."
+  spec.summary = "Ruby library for the Mergent API."
+  spec.description = "Ruby library for the Mergent API. See https://mergent.co for details."
   spec.homepage = "https://mergent.co"
   spec.license = "MIT"
   spec.required_ruby_version = ">= 2.6.0"
 
   spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = "https://github.com/jamescmartinez/mergent-ruby"
-  spec.metadata["changelog_uri"] = "https://github.com/jamescmartinez/mergent-ruby/blob/main/CHANGELOG.md"
+  spec.metadata["source_code_uri"] = "https://github.com/mergentlabs/mergent-ruby"
+  spec.metadata["changelog_uri"] = "https://github.com/mergentlabs/mergent-ruby/blob/main/CHANGELOG.md"
+  spec.metadata["rubygems_mfa_required"] = "true"
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: mergent
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Mergent
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-11-21 00:00:00.000000000 Z
+date: 2022-01-20 00:00:00.000000000 Z
 dependencies: []
-description: See https://mergent.co for details.
+description: Ruby library for the Mergent API. See https://mergent.co for details.
 email: support@mergent.co
 executables: []
 extensions: []
@@ -18,6 +18,7 @@ extra_rdoc_files: []
 files:
 - ".rspec"
 - ".rubocop.yml"
+- ".ruby-version"
 - CHANGELOG.md
 - Gemfile
 - Gemfile.lock
@@ -28,6 +29,7 @@ files:
 - lib/mergent/client.rb
 - lib/mergent/errors.rb
 - lib/mergent/object.rb
+- lib/mergent/request_validator.rb
 - lib/mergent/task.rb
 - lib/mergent/version.rb
 - mergent.gemspec
@@ -36,8 +38,9 @@ licenses:
 - MIT
 metadata:
   homepage_uri: https://mergent.co
-  source_code_uri: https://github.com/jamescmartinez/mergent-ruby
-  changelog_uri: https://github.com/jamescmartinez/mergent-ruby/blob/main/CHANGELOG.md
+  source_code_uri: https://github.com/mergentlabs/mergent-ruby
+  changelog_uri: https://github.com/mergentlabs/mergent-ruby/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -53,8 +56,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.3.3
 signing_key:
 specification_version: 4
-summary: Ruby bindings for the Mergent API
+summary: Ruby library for the Mergent API.
 test_files: []