active_campaign_rb 0.1.0

data/lib/active_campaign_rb/errors.rb

@@ -0,0 +1,181 @@
+# frozen_string_literal: true
+
+module ActiveCampaignRb
+  #
+  # Base class error for almost all exceptions
+  #
+  # @author Mikael Henriksson <mikael@mhenrixon.com>
+  #
+  class Error < RuntimeError
+    def initialize(response = nil, exception = nil)
+      self.response = response
+      @exception    = exception
+      super
+    end
+
+    def message
+      if response.nil?
+        super
+      else
+        <<~MESSAGE
+          STATUS: #{response.status}
+          URL: #{env.url}
+          REQUEST HEADERS: #{env.request_headers}
+          RESPONSE_HEADERS: #{env.response_headers}
+          REQUEST_BODY: #{env.request_body}\n\n"
+          RESPONSE_BODY: #{response.body}\n\n"
+        MESSAGE
+      end
+    end
+
+    private
+
+    def env
+      @env ||= response.env
+    end
+
+    attr_accessor :response
+  end
+
+  #
+  # Proxy an exception to allow nil to be passed in
+  #
+  # @author Mikael Henriksson <mikael@mhenrixon.com>
+  #
+  class ErrorProxy < RuntimeError
+    def initialize(error = nil)
+      self.error = error
+      super
+    end
+
+    def message
+      error ? error.message : super
+    end
+
+    private
+
+    attr_accessor :error
+  end
+
+  #
+  # Wraps Faraday::ParsingError
+  #
+  # @author Mikael Henriksson <mikael@mhenrixon.com>
+  #
+  class ParsingError < ErrorProxy
+  end
+
+  #
+  # Wraps Faraday::ClientError
+  #
+  # @author Mikael Henriksson <mikael@mhenrixon.com>
+  #
+  class ClientError < Error
+  end
+
+  class InvalidHTTPMethod < StandardError
+  end
+
+  #
+  # Wraps Faraday::BadRequestError
+  #
+  # @author Mikael Henriksson <mikael@mhenrixon.com>
+  #
+  class BadRequestError < ClientError
+  end
+
+  #
+  # Wraps Faraday::UnauthorizedError
+  #
+  # @author Mikael Henriksson <mikael@mhenrixon.com>
+  #
+  class UnauthorizedError < ClientError
+  end
+
+  #
+  # Wraps Faraday::ForbiddenError
+  #
+  # @author Mikael Henriksson <mikael@mhenrixon.com>
+  #
+  class ForbiddenError < ClientError
+  end
+
+  #
+  # Wraps Faraday::ResourceNotFound
+  #
+  # @author Mikael Henriksson <mikael@mhenrixon.com>
+  #
+  class ResourceNotFound < ClientError
+  end
+
+  #
+  # Wraps Faraday::ProxyAuthError
+  #
+  # @author Mikael Henriksson <mikael@mhenrixon.com>
+  #
+  class ProxyAuthError < ClientError
+  end
+
+  #
+  # Wraps Faraday::ConflictError
+  #
+  # @author Mikael Henriksson <mikael@mhenrixon.com>
+  #
+  class ConflictError < ClientError
+  end
+
+  #
+  # Wraps Faraday::UnprocessableEntityError
+  #
+  # @author Mikael Henriksson <mikael@mhenrixon.com>
+  #
+  class UnprocessableEntityError < ClientError
+  end
+
+  #
+  # Wraps Faraday::ServerError
+  #
+  # @author Mikael Henriksson <mikael@mhenrixon.com>
+  #
+  class ServerError < Error
+  end
+
+  #
+  # Wraps Faraday::TimeoutError
+  #
+  # @author Mikael Henriksson <mikael@mhenrixon.com>
+  #
+  class TimeoutError < ErrorProxy
+    def initialize(exc = "timeout", response = nil)
+      super(response, exc)
+    end
+  end
+
+  #
+  # Wraps Faraday::NilStatusError
+  #
+  # @author Mikael Henriksson <mikael@mhenrixon.com>
+  #
+  class NilStatusError < ServerError
+    def initialize(exc, response = nil)
+      exc_msg_and_response!(exc, response)
+      super("http status could not be derived from the server response")
+    end
+  end
+
+  #
+  # Wraps Faraday::ConnectionFailed
+  #
+  # @author Mikael Henriksson <mikael@mhenrixon.com>
+  #
+  class ConnectionFailed < Error
+  end
+
+  #
+  # Wraps Faraday::SSLError
+  #
+  # @author Mikael Henriksson <mikael@mhenrixon.com>
+  #
+  class SSLError < Error
+  end
+end

data/lib/active_campaign_rb/faraday/middleware/request.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require "faraday"
+
+module ActiveCampaignRb
+  module Faraday
+    module Middleware
+      #
+      # Gem specific request middleware for Faraday
+      #
+      # @author Mikael Henriksson <mikael@mhenrixon.com>
+      #
+      class Request < ::Faraday::Middleware
+        dependency "oj"
+
+        include TransformHash
+
+        def initialize(app, headers)
+          super(app)
+          @headers = headers
+        end
+
+        def call(env)
+          case env.method
+          when :post, :patch, :put
+            normalize_body(env)
+          end
+
+          env[:request_headers].merge!(@headers)
+
+          @app.call(env)
+        end
+
+        def normalize_body(env)
+          body = env[:request_body]
+          if body.is_a?(Array)
+            body = transform_array(body.flatten, :camelcase, :lower)
+          elsif body.key?(:group)
+            logger.debug("Using body as is because group #{body}")
+          elsif body.key?(:list)
+            logger.debug("Using body as is because list #{body}")
+          else
+            body = transform_keys(body, :camelcase, :lower)
+          end
+
+          env[:request_body] = ::Oj.dump(body, mode: :compat)
+        end
+
+        def logger
+          @logger ||= Logger.new($stdout)
+        end
+      end
+    end
+  end
+end
+
+Faraday::Request.register_middleware active_campaign: ActiveCampaignRb::Faraday::Middleware::Request

data/lib/active_campaign_rb/faraday/middleware/response.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require "logger"
+require "faraday"
+require "faraday/logging/formatter"
+
+module ActiveCampaignRb
+  LOGGER = ::Logger.new($stdout)
+  module Faraday
+    module Middleware
+      #
+      # Gem specific response middleware for Faraday
+      #
+      # @author Mikael Henriksson <mikael@mhenrixon.com>
+      #
+      class Response < ::Faraday::Response::Middleware
+        dependency "oj"
+
+        include TransformHash
+
+        # Override this to modify the environment after the response has finished.
+        # Calls the `parse` method if defined
+        def on_complete(env)
+          env.body = parse(env.body)
+          debug(env) if ActiveCampaignRb.config.debug?
+        end
+
+        def parse(body)
+          return body if body.to_s.empty?
+
+          body = ::Oj.load(body, mode: :compat)
+          transform_keys(body, :underscore)
+        end
+
+        def debug(env)
+          formatter.request(env)
+          formatter.response(env)
+        end
+
+        def formatter
+          @formatter ||= ::Faraday::Logging::Formatter.new(
+            logger: LOGGER,
+            options: { headers: true, bodies: true }
+          )
+        end
+      end
+    end
+  end
+end
+
+Faraday::Response.register_middleware active_campaign: ActiveCampaignRb::Faraday::Middleware::Response

data/lib/active_campaign_rb/faraday/middleware.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require_relative "middleware/request"
+require_relative "middleware/response"
+
+module ActiveCampaignRb
+  module Faraday
+    #
+    # Utility functions for managing Faraday middlewares
+    #
+    # @author Mikael Henriksson <mikael@mhenrixon.com>
+    #
+    module Middleware
+      def self.add_request_middleware(faraday, middleware = {})
+        faraday.request :active_campaign, {}
+
+        return if middleware.none?
+
+        middleware.each do |key, options|
+          faraday.request key, options unless key.to_s.empty?
+        end
+      end
+
+      def self.add_response_middleware(faraday, middleware = {})
+        faraday.response :active_campaign
+
+        return if middleware.none?
+
+        middleware.each do |key, **options|
+          next if key.to_s.empty?
+
+          add_middleware(faraday, key, options)
+        end
+      end
+
+      def self.add_middleware(faraday, key, options)
+        if options.is_a?(Hash) && options.any?
+          faraday.response key, options
+        else
+          faraday.response key
+        end
+      end
+    end
+  end
+end

data/lib/active_campaign_rb/http_client.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+module ActiveCampaignRb
+  #
+  # HTTP Client wrapper
+  #
+  class HttpClient
+    attr_reader :connection
+
+    def initialize(opts = {})
+      @connection = ::Faraday.new(url: opts.api_endpoint) do |f|
+        ActiveCampaignRb::Faraday::Middleware.add_request_middleware(f, opts.request_middleware)
+        ActiveCampaignRb::Faraday::Middleware.add_response_middleware(f, opts.response_middleware)
+        f.adapter opts.adapter
+
+        f.headers = {
+          "Accept" => "application/json",
+          "Content-Type" => "application/json",
+          "Api-Token" => opts.api_key,
+          "User-Agent" => "ActiveCampaignRb Client (v#{ActiveCampaignRb::VERSION})"
+        }
+      end
+    end
+
+    def post(*args)
+      safe_http_call do
+        connection.post(*args)
+      end
+    end
+
+    def patch(*args)
+      safe_http_call do
+        connection.patch(*args)
+      end
+    end
+
+    def put(*args)
+      safe_http_call do
+        connection.put(*args)
+      end
+    end
+
+    def delete(*args)
+      safe_http_call do
+        connection.delete(*args)
+      end
+    end
+
+    def get(*args)
+      safe_http_call do
+        connection.get(*args)
+      end
+    end
+
+    private
+
+    # rubocop:disable Metrics/MethodLength
+    # rubocop:disable Metrics/AbcSize
+    def safe_http_call
+      response = yield
+      response.body
+    rescue ::Oj::ParseError => e
+      raise ParsingError, e
+    rescue ::Faraday::BadRequestError => e
+      raise BadRequestError, e
+    rescue ::Faraday::UnauthorizedError => e
+      raise UnauthorizedError, e
+    rescue ::Faraday::ForbiddenError => e
+      raise ForbiddenError, e
+    rescue ::Faraday::ResourceNotFound => e
+      raise ResourceNotFound, e
+    rescue ::Faraday::ProxyAuthError => e
+      raise ProxyAuthError, e
+    rescue ::Faraday::ConflictError => e
+      raise ConflictError, e
+    rescue ::Faraday::UnprocessableEntityError => e
+      raise UnprocessableEntityError, e
+    rescue ::Faraday::ServerError => e
+      raise ServerError, e
+    rescue ::Faraday::TimeoutError => e
+      raise TimeoutError, e
+    rescue ::Faraday::NilStatusError => e
+      raise NilStatusError, e
+    rescue ::Faraday::ConnectionFailed => e
+      raise ConnectionFailed, e
+    rescue ::Faraday::SSLError => e
+      raise SSLError, e
+    end
+    # rubocop:enable Metrics/MethodLength
+    # rubocop:enable Metrics/AbcSize
+  end
+end

data/lib/active_campaign_rb/transform_hash.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require "active_support/core_ext/string"
+
+module ActiveCampaignRb
+  #
+  # Utility methods
+  #
+  module TransformHash
+    module_function
+
+    def transform_keys(hash, *new_case)
+      hash.each_with_object({}) do |(key, value), memo|
+        memo[transform_key(key, *new_case)] = transform_value(value, *new_case)
+      end
+    end
+
+    def transform_key(key, *new_case)
+      key.to_s.public_send(*new_case).to_sym
+    end
+
+    def transform_value(value, *new_case)
+      case value
+      when Hash
+        transform_keys(value, *new_case)
+      when Array
+        transform_array(value, *new_case)
+      else
+        value
+      end
+    end
+
+    def transform_array(collection, *new_case)
+      collection.map do |element|
+        case element
+        when Hash
+          transform_keys(element, *new_case)
+        else
+          element
+        end
+      end
+    end
+  end
+end

data/lib/active_campaign_rb/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module ActiveCampaignRb
+  VERSION = "0.1.0"
+end

data/lib/active_campaign_rb.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require "yaml"
+
+require_relative "active_campaign_rb/version"
+require_relative "active_campaign_rb/errors"
+require_relative "active_campaign_rb/transform_hash"
+require_relative "active_campaign_rb/faraday/middleware"
+require_relative "active_campaign_rb/config"
+require_relative "active_campaign_rb/http_client"
+
+#
+# API Client for the Active Campaign API v3
+#
+#
+module ActiveCampaignRb
+  module_function
+
+  ENDPOINTS = YAML.load_file(File.join(File.dirname(__FILE__), "active_campaign_rb", "endpoints.yaml"))
+
+  def config
+    @config ||= Config.new
+  end
+
+  def configure
+    yield config if block_given?
+  end
+
+  def http_client
+    @http_client ||= HttpClient.new(config)
+  end
+
+  ENDPOINTS.each do |name, config|
+    define_method(name) do |**args|
+      http_methods = config.dig(:link, :method)
+      request_path = config.dig(:link, :href)
+
+      case http_methods
+      when :GET, :get
+        http_client.get(request_path % args, args)
+      when :POST, :post
+        http_client.post(request_path % args, args)
+      when :PUT, :put
+        http_client.put(request_path % args, args)
+      when :PATCH, :patch
+        http_client.path(request_path % args, args)
+      when :DELETE, :delete
+        http_client.delete(request_path % args, args)
+      else
+        raise InvalidHTTPMethod, "Invalid http_method specified"
+      end
+    rescue ::KeyError => e
+      raise ArgumentError, e
+    end
+  end
+end

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: active_campaign_rb
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- spidergears
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-11-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+description:
+email:
+- deepak@eloquent.studio
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gem_release.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- active_campaign_rb.gemspec
+- bin/console
+- bin/setup
+- lib/active_campaign_rb.rb
+- lib/active_campaign_rb/config.rb
+- lib/active_campaign_rb/endpoints.yaml
+- lib/active_campaign_rb/errors.rb
+- lib/active_campaign_rb/faraday/middleware.rb
+- lib/active_campaign_rb/faraday/middleware/request.rb
+- lib/active_campaign_rb/faraday/middleware/response.rb
+- lib/active_campaign_rb/http_client.rb
+- lib/active_campaign_rb/transform_hash.rb
+- lib/active_campaign_rb/version.rb
+homepage: https://github.com/EloquentStudio/active_campaign_rb/blob/master/CHANGELOG.md
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/EloquentStudio/active_campaign_rb/blob/master/CHANGELOG.md
+  source_code_uri: https://github.com/EloquentStudio/active_campaign_rb
+  changelog_uri: https://github.com/EloquentStudio/active_campaign_rb/blob/master/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.15
+signing_key:
+specification_version: 4
+summary: Ruby wrapper around active campaign api
+test_files: []