mirakl 0.0.1

data/lib/mirakl/mirakl_object.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Mirakl
+  class MiraklObject
+    include Enumerable
+
+    # def initialize(id = nil, opts = {})
+    #   id, @retrieve_params = Util.normalize_id(id)
+    #   @opts = Util.normalize_opts(opts)
+    #   @original_values = {}
+    #   @values = {}
+    #   # This really belongs in APIResource, but not putting it there allows us
+    #   # to have a unified inspect method
+    #   @unsaved_values = Set.new
+    #   @transient_values = Set.new
+    #   @values[:id] = id if id
+    # end
+
+    def initialize
+      @values = {}
+    end
+
+    def data
+      @values
+    end
+
+
+
+    def self.construct_from(values, opts = {})
+      values = Mirakl::Util.symbolize_names(values)
+
+      # work around protected #initialize_from for now
+      new().send(:initialize_from, values, opts)
+    end
+
+
+    protected def initialize_from(values, opts, partial = false)
+      @opts = Util.normalize_opts(opts)
+
+      values.each do |k, v|
+        @values[k] = Util.convert_to_mirakl_object(v, @opts)
+      end
+
+      self
+    end
+
+  end
+end

data/lib/mirakl/mirakl_response.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Mirakl
+  # MiraklResponse encapsulates some vitals of a response that came back from
+  # the Mirakl API.
+  class MiraklResponse
+    # The data contained by the HTTP body of the response deserialized from
+    # JSON.
+    attr_accessor :data
+
+    # The raw HTTP body of the response.
+    attr_accessor :http_body
+
+    # A Hash of the HTTP headers of the response.
+    attr_accessor :http_headers
+
+    # The integer HTTP status code of the response.
+    attr_accessor :http_status
+
+    # The Stripe request ID of the response.
+    attr_accessor :request_id
+
+    # Initializes a MiraklResponse object from a Hash like the kind returned as
+    # part of a Faraday exception.
+    #
+    # This may throw JSON::ParserError if the response body is not valid JSON.
+    def self.from_faraday_hash(http_resp)
+
+      puts http_resp.inspect
+
+      resp = MiraklResponse.new
+      resp.data = JSON.parse(http_resp[:body], symbolize_names: true)
+      resp.http_body = http_resp[:body]
+      resp.http_headers = http_resp[:headers]
+      resp.http_status = http_resp[:status]
+      resp
+    end
+
+    # Initializes a MiraklResponse object from a Faraday HTTP response object.
+    #
+    # This may throw JSON::ParserError if the response body is not valid JSON.
+    def self.from_faraday_response(http_resp)
+      resp = MiraklResponse.new
+      resp.data = JSON.parse(http_resp.body, symbolize_names: true)
+      resp.http_body = http_resp.body
+      resp.http_headers = http_resp.headers
+      resp.http_status = http_resp.status
+      resp
+    end
+  end
+end

data/lib/mirakl/requests/dr11.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Mirakl
+  module Requests
+    class DR11
+      include Mirakl::ApiOperations::Request
+
+      API_PATH = 'document-request/requests'
+
+      def self.call(params = {}, opts = {})
+        resp, opts = request(:get, API_PATH, params, opts)
+        obj = MiraklObject.construct_from(resp.data, opts)
+
+        obj
+      end
+    end
+  end
+end

data/lib/mirakl/requests/dr74.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Mirakl
+  module Requests
+    class DR74
+      include Mirakl::ApiOperations::Request
+
+      API_PATH = 'document-request/documents/upload'
+
+      def self.call(params = {}, opts = {})
+
+        raise ArgumentError, "files must be an array" if params[:files].nil? ||
+          !params[:files].is_a?(Array)
+
+        params[:files] = params[:files].map do |fp|
+          unless fp.respond_to?(:read)
+            raise ArgumentError, "each file must respond to `#read`"
+          end
+
+          Faraday::FilePart.new(fp, 'application/pdf', File.basename(fp))
+        end
+
+        # params[:files] = params[:files][0]
+
+        raise ArgumentError, "documents_input must be a Hash" if params[:documents_input].nil? ||
+          !params[:documents_input].is_a?(Hash)
+
+        params[:documents_input] = Faraday::ParamPart.new(params[:documents_input].to_json, 'application/json')
+
+        puts params.inspect
+
+        opts = {
+          content_type: "multipart/form-data",
+        }.merge(Util.normalize_opts(opts))
+
+        resp, opts = request(:post, API_PATH, params, opts)
+        obj = MiraklObject.construct_from(resp.data, opts)
+
+        obj
+      end
+
+
+    end
+  end
+end

data/lib/mirakl/requests/s07.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Mirakl
+  module Requests
+    class S07
+      include Mirakl::ApiOperations::Request
+
+      API_PATH = 'shops'
+
+      def self.call(params = {}, opts = {})
+        resp, opts = request(:put, API_PATH, params, opts)
+        obj = MiraklObject.construct_from(resp.data, opts)
+
+        obj
+      end
+    end
+  end
+end

data/lib/mirakl/requests/s20.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Mirakl
+  module Requests
+    class S20
+      include Mirakl::ApiOperations::Request
+
+      API_PATH = 'shops'
+
+      def self.call(params = {}, opts = {})
+        resp, opts = request(:get, API_PATH, params, opts)
+        obj = MiraklObject.construct_from(resp.data, opts)
+
+        obj
+      end
+    end
+  end
+end

data/lib/mirakl/util.rb

@@ -0,0 +1,282 @@
+# frozen_string_literal: true
+
+require "cgi"
+
+module Mirakl
+  module Util
+
+    # Options that a user is allowed to specify.
+    OPTS_USER_SPECIFIED = Set[
+      :api_key,
+    ].freeze
+
+    # Options that should be copyable from one StripeObject to another
+    # including options that may be internal.
+    OPTS_COPYABLE = (
+      OPTS_USER_SPECIFIED + Set[:api_base]
+    ).freeze
+
+    # Options that should be persisted between API requests. This includes
+    # client, which is an object containing an HTTP client to reuse.
+    OPTS_PERSISTABLE = (
+      OPTS_USER_SPECIFIED + Set[:client]
+    ).freeze
+
+    # Converts a hash of fields or an array of hashes into a +MiraklObject+ or
+    # array of +MiraklObject+s.
+    #
+    # ==== Attributes
+    #
+    # * +data+ - Hash of fields and values to be converted into a MiraklObject.
+    # * +opts+ - Options for +MiraklObject+ like an API key that will be reused
+    #   on subsequent API calls.
+    def self.convert_to_mirakl_object(data, opts = {})
+      opts = normalize_opts(opts)
+
+      case data
+      when Array
+        data.map { |i| convert_to_mirakl_object(i, opts) }
+      when Hash
+        data
+        # Try converting to a known object class.  If none available, fall back
+        # to generic StripeObject
+        # MiraklObject.construct_from(data, opts)
+      else
+        data
+      end
+    end
+
+
+    def self.log_error(message, data = {})
+      if !Mirakl.logger.nil? ||
+         !Mirakl.log_level.nil? && Mirakl.log_level <= Mirakl::LEVEL_ERROR
+        log_internal(message, data, color: :cyan, level: Mirakl::LEVEL_ERROR,
+                                    logger: Mirakl.logger, out: $stderr)
+      end
+    end
+
+    def self.log_info(message, data = {})
+      if !Mirakl.logger.nil? ||
+         !Mirakl.log_level.nil? && Mirakl.log_level <= Mirakl::LEVEL_INFO
+        log_internal(message, data, color: :cyan, level: Mirakl::LEVEL_INFO,
+                                    logger: Mirakl.logger, out: $stdout)
+      end
+    end
+
+    def self.log_debug(message, data = {})
+      if !Mirakl.logger.nil? ||
+         !Mirakl.log_level.nil? && Mirakl.log_level <= Mirakl::LEVEL_DEBUG
+        log_internal(message, data, color: :blue, level: Mirakl::LEVEL_DEBUG,
+                                    logger: Mirakl.logger, out: $stdout)
+      end
+    end
+
+    def self.symbolize_names(object)
+      case object
+      when Hash
+        new_hash = {}
+        object.each do |key, value|
+          key = (begin
+                   key.to_sym
+                 rescue StandardError
+                   key
+                 end) || key
+          new_hash[key] = symbolize_names(value)
+        end
+        new_hash
+      when Array
+        object.map { |value| symbolize_names(value) }
+      else
+        object
+      end
+    end
+
+    # Encodes a hash of parameters in a way that's suitable for use as query
+    # parameters in a URI or as form parameters in a request body. This mainly
+    # involves escaping special characters from parameter keys and values (e.g.
+    # `&`).
+    def self.encode_parameters(params)
+      Util.flatten_params(params)
+          .map { |k, v| "#{url_encode(k)}=#{url_encode(v)}" }.join("&")
+    end
+
+    # Encodes a string in a way that makes it suitable for use in a set of
+    # query parameters in a URI or in a set of form parameters in a request
+    # body.
+    def self.url_encode(key)
+      CGI.escape(key.to_s).
+        # Don't use strict form encoding by changing the square bracket control
+        # characters back to their literals. This is fine by the server, and
+        # makes these parameter strings easier to read.
+        gsub("%5B", "[").gsub("%5D", "]")
+    end
+
+    def self.flatten_params(params, parent_key = nil)
+      result = []
+
+      # do not sort the final output because arrays (and arrays of hashes
+      # especially) can be order sensitive, but do sort incoming parameters
+      params.each do |key, value|
+        calculated_key = parent_key ? "#{parent_key}[#{key}]" : key.to_s
+        if value.is_a?(Hash)
+          result += flatten_params(value, calculated_key)
+        elsif value.is_a?(Array)
+          result += flatten_params_array(value, calculated_key)
+        else
+          result << [calculated_key, value]
+        end
+      end
+
+      result
+    end
+
+    def self.flatten_params_array(value, calculated_key)
+      result = []
+      value.each_with_index do |elem, i|
+        if elem.is_a?(Hash)
+          result += flatten_params(elem, "#{calculated_key}[#{i}]")
+        elsif elem.is_a?(Array)
+          result += flatten_params_array(elem, calculated_key)
+        else
+          result << ["#{calculated_key}[#{i}]", elem]
+        end
+      end
+      result
+    end
+
+    # The secondary opts argument can either be a string or hash
+    # Turn this value into an api_key and a set of headers
+    def self.normalize_opts(opts)
+      case opts
+      when String
+        { api_key: opts }
+      when Hash
+        check_api_key!(opts.fetch(:api_key)) if opts.key?(:api_key)
+        opts.clone
+      else
+        raise TypeError, "normalize_opts expects a string or a hash"
+      end
+    end
+
+    def self.check_string_argument!(key)
+      raise TypeError, "argument must be a string" unless key.is_a?(String)
+      key
+    end
+
+    def self.check_api_key!(key)
+      raise TypeError, "api_key must be a string" unless key.is_a?(String)
+      key
+    end
+
+    # Normalizes header keys so that they're all lower case and each
+    # hyphen-delimited section starts with a single capitalized letter. For
+    # example, `request-id` becomes `Request-Id`. This is useful for extracting
+    # certain key values when the user could have set them with a variety of
+    # diffent naming schemes.
+    def self.normalize_headers(headers)
+      headers.each_with_object({}) do |(k, v), new_headers|
+        k = k.to_s.tr("_", "-") if k.is_a?(Symbol)
+        k = k.split("-").reject(&:empty?).map(&:capitalize).join("-")
+
+        new_headers[k] = v
+      end
+    end
+
+    #
+    # private
+    #
+
+    COLOR_CODES = {
+      black:   0, light_black:   60,
+      red:     1, light_red:     61,
+      green:   2, light_green:   62,
+      yellow:  3, light_yellow:  63,
+      blue:    4, light_blue:    64,
+      magenta: 5, light_magenta: 65,
+      cyan:    6, light_cyan:    66,
+      white:   7, light_white:   67,
+      default: 9,
+    }.freeze
+    private_constant :COLOR_CODES
+
+    # Uses an ANSI escape code to colorize text if it's going to be sent to a
+    # TTY.
+    def self.colorize(val, color, isatty)
+      return val unless isatty
+
+      mode = 0 # default
+      foreground = 30 + COLOR_CODES.fetch(color)
+      background = 40 + COLOR_CODES.fetch(:default)
+
+      "\033[#{mode};#{foreground};#{background}m#{val}\033[0m"
+    end
+    private_class_method :colorize
+
+    # Turns an integer log level into a printable name.
+    def self.level_name(level)
+      case level
+      when LEVEL_DEBUG then "debug"
+      when LEVEL_ERROR then "error"
+      when LEVEL_INFO  then "info"
+      else level
+      end
+    end
+    private_class_method :level_name
+
+    # TODO: Make these named required arguments when we drop support for Ruby
+    # 2.0.
+    def self.log_internal(message, data = {}, color: nil, level: nil,
+                          logger: nil, out: nil)
+      data_str = data.reject { |_k, v| v.nil? }
+                     .map do |(k, v)|
+        format("%<key>s=%<value>s",
+               key: colorize(k, color, logger.nil? && !out.nil? && out.isatty),
+               value: wrap_logfmt_value(v))
+      end.join(" ")
+
+      if !logger.nil?
+        # the library's log levels are mapped to the same values as the
+        # standard library's logger
+        logger.log(level,
+                   format("message=%<message>s %<data_str>s",
+                          message: wrap_logfmt_value(message),
+                          data_str: data_str))
+      elsif out.isatty
+        out.puts format("%<level>s %<message>s %<data_str>s",
+                        level: colorize(level_name(level)[0, 4].upcase,
+                                        color, out.isatty),
+                        message: message,
+                        data_str: data_str)
+      else
+        out.puts format("message=%<message>s level=%<level>s %<data_str>s",
+                        message: wrap_logfmt_value(message),
+                        level: level_name(level),
+                        data_str: data_str)
+      end
+    end
+    private_class_method :log_internal
+
+    # Wraps a value in double quotes if it looks sufficiently complex so that
+    # it can be read by logfmt parsers.
+    def self.wrap_logfmt_value(val)
+      # If value is any kind of number, just allow it to be formatted directly
+      # to a string (this will handle integers or floats).
+      return val if val.is_a?(Numeric)
+
+      # Hopefully val is a string, but protect in case it's not.
+      val = val.to_s
+
+      if %r{[^\w\-/]} =~ val
+        # If the string contains any special characters, escape any double
+        # quotes it has, remove newlines, and wrap the whole thing in quotes.
+        format(%("%<value>s"), value: val.gsub('"', '\"').delete("\n"))
+      else
+        # Otherwise use the basic value if it looks like a standard set of
+        # characters (and allow a few special characters like hyphens, and
+        # slashes)
+        val
+      end
+    end
+    private_class_method :wrap_logfmt_value
+  end
+end

data/lib/mirakl/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Mirakl
+  VERSION = "0.0.1".freeze
+end

data/lib/mirakl.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+# Mirakl Ruby bindings
+require "cgi"
+require "faraday"
+require "json"
+require "logger"
+require "rbconfig"
+require "set"
+require "socket"
+require "uri"
+
+require "mirakl/version"
+
+# API operations
+require "mirakl/api_operations/request"
+
+# Resources
+require "mirakl/requests/dr11"
+require "mirakl/requests/dr74"
+require "mirakl/requests/s07"
+require "mirakl/requests/s20"
+
+# API resource support classes
+require "mirakl/util"
+require "mirakl/errors"
+require "mirakl/mirakl_response"
+require "mirakl/mirakl_client"
+require "mirakl/mirakl_object"
+
+
+
+module Mirakl
+  @api_base = 'https://octobat-dev.mirakl.net/api/'
+
+  @open_timeout = 30
+  @read_timeout = 80
+
+  @log_level = nil
+  @logger = nil
+
+  class << self
+    attr_accessor :api_key, :api_base, :open_timeout, :read_timeout
+  end
+
+  # map to the same values as the standard library's logger
+  LEVEL_DEBUG = Logger::DEBUG
+  LEVEL_ERROR = Logger::ERROR
+  LEVEL_INFO = Logger::INFO
+
+  # When set prompts the library to log some extra information to $stdout and
+  # $stderr about what it's doing. For example, it'll produce information about
+  # requests, responses, and errors that are received. Valid log levels are
+  # `debug` and `info`, with `debug` being a little more verbose in places.
+  #
+  # Use of this configuration is only useful when `.logger` is _not_ set. When
+  # it is, the decision what levels to print is entirely deferred to the logger.
+  def self.log_level
+    @log_level
+  end
+
+  def self.log_level=(val)
+    # Backwards compatibility for values that we briefly allowed
+    if val == "debug"
+      val = LEVEL_DEBUG
+    elsif val == "info"
+      val = LEVEL_INFO
+    end
+
+    if !val.nil? && ![LEVEL_DEBUG, LEVEL_ERROR, LEVEL_INFO].include?(val)
+      raise ArgumentError,
+            "log_level should only be set to `nil`, `debug` or `info`"
+    end
+    @log_level = val
+  end
+
+  # Sets a logger to which logging output will be sent. The logger should
+  # support the same interface as the `Logger` class that's part of Ruby's
+  # standard library (hint, anything in `Rails.logger` will likely be
+  # suitable).
+  #
+  # If `.logger` is set, the value of `.log_level` is ignored. The decision on
+  # what levels to print is entirely deferred to the logger.
+  def self.logger
+    @logger
+  end
+
+  def self.logger=(val)
+    @logger = val
+  end
+
+end
+
+Mirakl.log_level = ENV["MIRAKL_LOG"] unless ENV["MIRAKL_LOG"].nil?

data/mirakl.gemspec

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift(::File.join(::File.dirname(__FILE__), "lib"))
+
+require "mirakl/version"
+
+Gem::Specification.new do |s|
+  s.name = "mirakl"
+  s.version = Mirakl::VERSION
+  s.required_ruby_version = ">= 2.1.0"
+  s.summary = "Ruby bindings for the Mirakl API"
+  s.description = ""
+  s.author = "Mirakl"
+  s.email = "gaultier.laperche@mirakl.com"
+  s.homepage = "https://www.mirakl.com/"
+  s.license = "MIT"
+
+  s.metadata = {
+    "bug_tracker_uri"   => "https://github.com/mirakl/mirakl-ruby/issues",
+    "changelog_uri"     =>
+      "https://github.com/mirakl/mirakl-ruby/blob/master/CHANGELOG.md",
+    "github_repo"       => "ssh://github.com/mirakl/mirakl-ruby",
+  }
+
+  s.add_dependency("faraday", "~> 1.8")
+  s.add_dependency("net-http-persistent", "~> 3.0")
+
+  s.files = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- test/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n")
+                                           .map { |f| ::File.basename(f) }
+  s.require_paths = ["lib"]
+end