mergent 0.2.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cc06e24825269b013a4a16a36b4efbacce4bff7072a3f477d315a2662b6e9d1b
-  data.tar.gz: e1827059fe19cce91e14bacea197db6d56d9faafb4499103e2a03515491064be
+  metadata.gz: 9281f04808d0bf4eb2e778860b8a6b0d3ecd3a14c998a17b73706aac8f020994
+  data.tar.gz: a971e955775cbf0786567c001a814ca751c6f82c552cca96308fe5e263c55aaf
 SHA512:
-  metadata.gz: 2b205d9443bb5589e6425969bc735fdfb01b43f14b60c5b94b5409e8ce4113c11c3504f2f28dd1898030a4ca2364d7162367ff59f4483ea1d0d299ac4182b953
-  data.tar.gz: baeff3cb6c216746c0b39007b4271282cdc85a9c2ef9de0d7953a0ad6cd46e0a09b4bbec8b231377f72ae2ee977b6d0255ff58f3292d00002faacf507682a57b
+  metadata.gz: e060f3a1fe02989554c49f9023880fe263263ab72c86ec26ef5710f324b201b21518d52d834e9357ab6a85263acbae9ba8e787e344fa7073824f366ed77af40e
+  data.tar.gz: 0226c8ea2989c7d120d396961676956a1b813d657e794e2e0b998554310411eb5d78be5866990b77e182e65915093d750fe51721e36617686466b3733279bde2

data/CHANGELOG.md

@@ -1,5 +1,22 @@
 ## [Unreleased]
 
+## [1.0] - 2022-03-10
+
+- Switch to the V2 API
+  - Add `id` attribute to Task
+  - Make `name` optional
+  - Add optional `queue` attribute to Task that defaults to `default`
+  - Remove `description` from Task
+- Add support for creating, deleting, and updating Schedules
+
+## [0.2.2] - 2022-01-20
+
+- Add `Mergent::RequestValidator` to validate that webhooks came from Mergent's API
+
+## [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

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    mergent (0.2.0)
+    mergent (1.0.0)
 
 GEM
   remote: https://rubygems.org/
@@ -14,43 +14,43 @@ GEM
     diff-lcs (1.5.0)
     hashdiff (1.0.1)
     parallel (1.21.0)
-    parser (3.1.0.0)
+    parser (3.1.1.0)
       ast (~> 2.4.1)
     public_suffix (4.0.6)
     rainbow (3.1.1)
     rake (13.0.6)
-    regexp_parser (2.2.0)
+    regexp_parser (2.2.1)
     rexml (3.2.5)
-    rspec (3.10.0)
-      rspec-core (~> 3.10.0)
-      rspec-expectations (~> 3.10.0)
-      rspec-mocks (~> 3.10.0)
-    rspec-core (3.10.1)
-      rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.2)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.2)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-support (3.10.3)
-    rubocop (1.24.1)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    rubocop (1.26.0)
       parallel (~> 1.10)
-      parser (>= 3.0.0.0)
+      parser (>= 3.1.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml
-      rubocop-ast (>= 1.15.1, < 2.0)
+      rubocop-ast (>= 1.16.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.15.1)
-      parser (>= 3.0.1.1)
-    rubocop-performance (1.13.2)
+    rubocop-ast (1.16.0)
+      parser (>= 3.1.1.0)
+    rubocop-performance (1.13.3)
       rubocop (>= 1.7.0, < 2.0)
       rubocop-ast (>= 0.4.0)
     rubocop-rake (0.6.0)
       rubocop (~> 1.0)
-    rubocop-rspec (2.7.0)
+    rubocop-rspec (2.9.0)
       rubocop (~> 1.19)
     ruby-progressbar (1.11.0)
     unicode-display_width (2.1.0)

data/README.md

@@ -34,8 +34,14 @@ Mergent.api_key = "..."
 # create a Task
 task = Mergent::Task.create({ request: { url: "https://example.com" } })
 
-# get the newly created Task's name
-task.name
+# get the newly created Task's ID
+task.id
+
+# create a Schedule
+schedule = Mergent::Schedule.create({ cron: "0 8 * * *", request: { url: "https://example.com" } })
+
+# get the newly created Schedule's cron schedule
+schedule.cron
 ```
 
 See the [Mergent Ruby docs](https://docs.mergent.co/libraries/ruby) for more

data/lib/mergent/client.rb

@@ -5,25 +5,42 @@ require "json"
 
 module Mergent
   class Client
-    def self.post(resource, params) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+    def self.post(resource, params)
+      request(Net::HTTP::Post, resource, params)
+    end
+
+    def self.delete(resource, params = {})
+      request(Net::HTTP::Delete, resource, params)
+    end
+
+    def self.patch(resource, params)
+      request(Net::HTTP::Patch, resource, params)
+    end
+
+    private
+
+    def self.request(request_class, resource, params) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
       uri = URI("#{Mergent.endpoint}/#{resource}")
       headers = {
         Authorization: "Bearer #{Mergent.api_key}",
         "Content-Type": "application/json"
       }
-      request = Net::HTTP::Post.new(uri, headers)
+      request = request_class.new(uri, headers)
       request.body = params.to_json
 
       https = Net::HTTP.new(uri.host, uri.port)
       https.use_ssl = Mergent.endpoint.start_with?("https")
       response = https.request(request)
 
+      read_body = response.read_body
+      response_body = read_body.nil? || read_body.empty? ? "{}" : read_body
+
       case response
       when Net::HTTPSuccess
-        JSON.parse(response.read_body)
+        JSON.parse(response_body)
       else
         begin
-          body = JSON.parse(response.read_body)
+          body = JSON.parse(response_body)
         rescue JSON::ParserError
           body = {}
         end
@@ -32,8 +49,7 @@ module Mergent
     rescue EOFError, Errno::ECONNREFUSED, Errno::ECONNRESET, Errno::EHOSTUNREACH, Errno::ETIMEDOUT, SocketError
       raise Mergent::ConnectionError
     end
-
-    private
+    private_class_method :request
 
     def self.error_message(body)
       breakdown = body.fetch("errors", []).map { |error| error.fetch("message", nil) }.compact.join(", ")

data/lib/mergent/object.rb

@@ -2,6 +2,8 @@
 
 module Mergent
   class Object
+    DEFAULT_QUEUE = "default"
+
     attr_reader :_data
 
     def initialize(data = {})

data/lib/mergent/request_validator.rb

@@ -6,14 +6,13 @@ module Mergent
       @api_key = api_key || Mergent.api_key
     end
 
-    def build_signature_for(url, body)
-      data = (url || "") + (body || "")
+    def build_signature(body)
       digest = OpenSSL::Digest.new("sha1")
-      Base64.strict_encode64(OpenSSL::HMAC.digest(digest, @api_key, data))
+      Base64.strict_encode64(OpenSSL::HMAC.digest(digest, @api_key, body || ""))
     end
 
-    def valid_signature?(url, body, signature)
-      build_signature_for(url, body) == signature
+    def valid_signature?(body, signature)
+      build_signature(body) == signature
     end
   end
 end

data/lib/mergent/schedule.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative "client"
+require_relative "object"
+
+module Mergent
+  class Schedule < Mergent::Object
+    ATTRS = %i[id queue cron rrule dtstart type description request created_at].freeze
+
+    ATTRS.each do |name|
+      define_method(name) do
+        @_data[name]
+      end
+    end
+
+    def self.create(params = {})
+      data = Client.post(
+        "schedules",
+        { queue: Mergent::Object::DEFAULT_QUEUE }.merge(params)
+      )
+      new(data)
+    end
+
+    def self.update(id, params)
+      data = Client.patch("schedules/#{id}", params)
+      new(data)
+    end
+
+    def self.delete(id)
+      Client.delete("schedules/#{id}")
+      true
+    end
+  end
+end

data/lib/mergent/task.rb

@@ -5,7 +5,7 @@ require_relative "object"
 
 module Mergent
   class Task < Mergent::Object
-    ATTRS = %i[name description status request scheduled_for created_at].freeze
+    ATTRS = %i[id name queue status request scheduled_for created_at].freeze
 
     ATTRS.each do |name|
       define_method(name) do
@@ -14,7 +14,10 @@ module Mergent
     end
 
     def self.create(params = {})
-      data = Client.post("tasks", params)
+      data = Client.post(
+        "tasks",
+        { queue: Mergent::Object::DEFAULT_QUEUE }.merge(params)
+      )
       new(data)
     end
   end

data/lib/mergent/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Mergent
-  VERSION = "0.2.0"
+  VERSION = "1.0.0"
 end

data/lib/mergent.rb

@@ -3,10 +3,11 @@
 require_relative "mergent/errors"
 require_relative "mergent/request_validator"
 require_relative "mergent/task"
+require_relative "mergent/schedule"
 require_relative "mergent/version"
 
 module Mergent
-  ENDPOINT = "https://api.mergent.co/v1"
+  ENDPOINT = "https://api.mergent.co/v2"
 
   class << self
     attr_accessor :api_key, :endpoint

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mergent
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Mergent
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-20 00:00:00.000000000 Z
+date: 2022-03-10 00:00:00.000000000 Z
 dependencies: []
 description: Ruby library for the Mergent API. See https://mergent.co for details.
 email: support@mergent.co
@@ -30,6 +30,7 @@ files:
 - lib/mergent/errors.rb
 - lib/mergent/object.rb
 - lib/mergent/request_validator.rb
+- lib/mergent/schedule.rb
 - lib/mergent/task.rb
 - lib/mergent/version.rb
 - mergent.gemspec