fangkuai.rb 0.0.1

data/lib/square/configuration.rb

@@ -0,0 +1,101 @@
+module Square
+  # All configuration including auth info and base URI for the API access
+  # are configured in this class.
+  class Configuration
+    # The attribute readers for properties.
+    attr_reader :http_client
+    attr_reader :timeout
+    attr_reader :max_retries
+    attr_reader :retry_interval
+    attr_reader :backoff_factor
+    attr_reader :environment
+    attr_reader :square_version
+    attr_reader :access_token
+
+    def additional_headers
+      @additional_headers.clone
+    end
+
+    class << self
+      attr_reader :environments
+    end
+
+    def initialize(timeout: 60, max_retries: 0, retry_interval: 1,
+                   backoff_factor: 1, environment: 'production',
+                   square_version: '2020-08-26', access_token: 'TODO: Replace',
+                   additional_headers: {})
+      # The value to use for connection timeout
+      @timeout = timeout
+
+      # The number of times to retry an endpoint call if it fails
+      @max_retries = max_retries
+
+      # Pause in seconds between retries
+      @retry_interval = retry_interval
+
+      # The amount to multiply each successive retry's interval amount
+      # by in order to provide backoff
+      @backoff_factor = backoff_factor
+
+      # Current API environment
+      @environment = String(environment)
+
+      # Square Connect API versions
+      @square_version = square_version
+
+      # OAuth 2.0 Access Token
+      @access_token = access_token
+
+      # Additional headers to add to each API request
+      @additional_headers = additional_headers.clone
+
+      # The Http Client to use for making requests.
+      @http_client = create_http_client
+    end
+
+    def clone_with(timeout: nil, max_retries: nil, retry_interval: nil,
+                   backoff_factor: nil, environment: nil, square_version: nil,
+                   access_token: nil, additional_headers: nil)
+      timeout ||= self.timeout
+      max_retries ||= self.max_retries
+      retry_interval ||= self.retry_interval
+      backoff_factor ||= self.backoff_factor
+      environment ||= self.environment
+      square_version ||= self.square_version
+      access_token ||= self.access_token
+      additional_headers ||= self.additional_headers
+
+      Configuration.new(timeout: timeout, max_retries: max_retries,
+                        retry_interval: retry_interval,
+                        backoff_factor: backoff_factor,
+                        environment: environment,
+                        square_version: square_version,
+                        access_token: access_token,
+                        additional_headers: additional_headers)
+    end
+
+    def create_http_client
+      FaradayClient.new(timeout: timeout, max_retries: max_retries,
+                        retry_interval: retry_interval,
+                        backoff_factor: backoff_factor)
+    end
+
+    # All the environments the SDK can run in.
+    ENVIRONMENTS = {
+      'production' => {
+        'default' => 'https://connect.squareup.com'
+      },
+      'sandbox' => {
+        'default' => 'https://connect.squareupsandbox.com'
+      }
+    }.freeze
+
+    # Generates the appropriate base URI for the environment and the server.
+    # @param [Configuration::Server] The server enum for which the base URI is
+    # required.
+    # @return [String] The base URI.
+    def get_base_uri(server = 'default')
+      ENVIRONMENTS[environment][server].clone
+    end
+  end
+end

data/lib/square/exceptions/api_exception.rb

@@ -0,0 +1,15 @@
+module Square
+  # Class for exceptions when there is a network error, status code error, etc.
+  class APIException < StandardError
+    attr_reader :response, :response_code
+
+    # The constructor.
+    # @param [String] The reason for raising an exception.
+    # @param [HttpResponse] The HttpReponse of the API call.
+    def initialize(reason, response)
+      super(reason)
+      @response = response
+      @response_code = response.status_code
+    end
+  end
+end

data/lib/square/http/api_response.rb

@@ -0,0 +1,45 @@
+module Square
+  # Http response received.
+  class ApiResponse
+    attr_reader(:status_code, :reason_phrase, :headers, :raw_body, :request,
+                :data, :errors, :body, :cursor)
+
+    # The constructor
+    # @param [HttpResponse] The original, raw response from the api.
+    # @param [Object] The data field specified for the response.
+    # @param [Array<String>] Any errors returned by the server.
+    def initialize(http_response,
+                   data: nil,
+                   errors: nil)
+      @status_code = http_response.status_code
+      @reason_phrase = http_response.reason_phrase
+      @headers = http_response.headers
+      @raw_body = http_response.raw_body
+      @request = http_response.request
+      @errors = errors
+
+      if data.is_a? Hash
+        if data.keys.any?
+          @body = Struct.new(*data.keys) do
+            define_method(:to_s) { http_response.raw_body }
+          end.new(*data.values)
+
+          @cursor = data.fetch(:cursor, nil)
+          data.reject! { |k| k == :cursor || k == :errors }
+          @data = Struct.new(*data.keys).new(*data.values) if data.keys.any?
+        end
+      else
+        @data = data
+        @body = data
+      end
+    end
+
+    def success?
+      status_code >= 200 && status_code < 300
+    end
+
+    def error?
+      status_code >= 400 && status_code < 600
+    end
+  end
+end

data/lib/square/http/auth/o_auth2.rb

@@ -0,0 +1,12 @@
+module Square
+  # Utility class for OAuth 2 authorization and token management.
+  class OAuth2
+    # Add OAuth2 authentication to the http request.
+    # @param [HttpRequest] The HttpRequest object to which authentication will
+    # be added.
+    def self.apply(config, http_request)
+      token = config.access_token
+      http_request.headers['Authorization'] = "Bearer #{token}"
+    end
+  end
+end

data/lib/square/http/faraday_client.rb

@@ -0,0 +1,55 @@
+require 'faraday/http_cache'
+require 'faraday_middleware'
+
+module Square
+  # An implementation of HttpClient.
+  class FaradayClient < HttpClient
+    # The constructor.
+    def initialize(timeout:, max_retries:, retry_interval:,
+                   backoff_factor:, cache: false, verify: true)
+      @connection = Faraday.new do |faraday|
+        faraday.use Faraday::HttpCache, serializer: Marshal if cache
+        faraday.use FaradayMiddleware::FollowRedirects
+        faraday.request :multipart
+        faraday.request :url_encoded
+        faraday.ssl[:ca_file] = Certifi.where
+        faraday.ssl[:verify] = verify
+        faraday.request :retry, max: max_retries, interval: retry_interval,
+                                backoff_factor: backoff_factor
+        faraday.adapter Faraday.default_adapter
+        faraday.options[:params_encoder] = Faraday::FlatParamsEncoder
+        faraday.options[:timeout] = timeout if timeout > 0
+      end
+    end
+
+    # Method overridden from HttpClient.
+    def execute_as_string(http_request)
+      response = @connection.send(
+        http_request.http_method.downcase,
+        http_request.query_url
+      ) do |request|
+        request.headers = http_request.headers
+        request.body = http_request.parameters
+      end
+      convert_response(response, http_request)
+    end
+
+    # Method overridden from HttpClient.
+    def execute_as_binary(http_request)
+      response = @connection.send(
+        http_request.http_method.downcase,
+        http_request.query_url
+      ) do |request|
+        request.headers = http_request.headers
+        request.body = http_request.parameters
+      end
+      convert_response(response, http_request)
+    end
+
+    # Method overridden from HttpClient.
+    def convert_response(response, http_request)
+      HttpResponse.new(response.status, response.reason_phrase,
+                       response.headers, response.body, http_request)
+    end
+  end
+end

data/lib/square/http/http_call_back.rb

@@ -0,0 +1,19 @@
+module Square
+  # HttpCallBack allows defining callables for pre and post API calls.
+  class HttpCallBack
+    # A controller will call this method before making an HTTP Request.
+    # @param [HttpRequest] The HttpRequest object which the HttpClient
+    # will execute.
+    def on_before_request(_http_request)
+      raise NotImplementedError, 'This method needs
+        to be implemented in a child class.'
+    end
+
+    # A controller will call this method after making an HTTP Request.
+    # @param [HttpResponse] The HttpReponse of the API call.
+    def on_after_response(_http_response)
+      raise NotImplementedError, 'This method needs
+        to be implemented in a child class.'
+    end
+  end
+end

data/lib/square/http/http_client.rb

@@ -0,0 +1,99 @@
+module Square
+  # An interface for the methods that an HTTP Client must implement.
+  #
+  # This class should not be instantiated but should be used as a base class
+  # for HTTP Client classes.
+  class HttpClient
+    # Execute an HttpRequest when the response is expected to be a string.
+    # @param [HttpRequest] The HttpRequest to be executed.
+    def execute_as_string(_http_request)
+      raise NotImplementedError, 'This method needs
+        to be implemented in a child class.'
+    end
+
+    # Execute an HttpRequest when the response is expected to be binary.
+    # @param [HttpRequest] The HttpRequest to be executed.
+    def execute_as_binary(_http_request)
+      raise NotImplementedError, 'This method needs
+        to be implemented in a child class.'
+    end
+
+    # Converts the HTTP Response from the client to an HttpResponse object.
+    # @param [Dynamic] The response object received from the client.
+    def convert_response(_response)
+      raise NotImplementedError, 'This method needs
+        to be implemented in a child class.'
+    end
+
+    # Get a GET HttpRequest object.
+    # @param [String] The URL to send the request to.
+    # @param [Hash, Optional] The headers for the HTTP Request.
+    def get(query_url,
+            headers: {})
+      HttpRequest.new(HttpMethodEnum::GET,
+                      query_url,
+                      headers: headers)
+    end
+
+    # Get a HEAD HttpRequest object.
+    # @param [String] The URL to send the request to.
+    # @param [Hash, Optional] The headers for the HTTP Request.
+    def head(query_url,
+             headers: {})
+      HttpRequest.new(HttpMethodEnum::HEAD,
+                      query_url,
+                      headers: headers)
+    end
+
+    # Get a POST HttpRequest object.
+    # @param [String] The URL to send the request to.
+    # @param [Hash, Optional] The headers for the HTTP Request.
+    # @param [Hash, Optional] The parameters for the HTTP Request.
+    def post(query_url,
+             headers: {},
+             parameters: {})
+      HttpRequest.new(HttpMethodEnum::POST,
+                      query_url,
+                      headers: headers,
+                      parameters: parameters)
+    end
+
+    # Get a PUT HttpRequest object.
+    # @param [String] The URL to send the request to.
+    # @param [Hash, Optional] The headers for the HTTP Request.
+    # @param [Hash, Optional] The parameters for the HTTP Request.
+    def put(query_url,
+            headers: {},
+            parameters: {})
+      HttpRequest.new(HttpMethodEnum::PUT,
+                      query_url,
+                      headers: headers,
+                      parameters: parameters)
+    end
+
+    # Get a PATCH HttpRequest object.
+    # @param [String] The URL to send the request to.
+    # @param [Hash, Optional] The headers for the HTTP Request.
+    # @param [Hash, Optional] The parameters for the HTTP Request.
+    def patch(query_url,
+              headers: {},
+              parameters: {})
+      HttpRequest.new(HttpMethodEnum::PATCH,
+                      query_url,
+                      headers: headers,
+                      parameters: parameters)
+    end
+
+    # Get a DELETE HttpRequest object.
+    # @param [String] The URL to send the request to.
+    # @param [Hash, Optional] The headers for the HTTP Request.
+    def delete(query_url,
+               headers: {},
+               parameters: {})
+      HttpRequest.new(HttpMethodEnum::DELETE,
+                      query_url,
+                      headers: headers,
+                      parameters: parameters)
+    end
+  end
+end

data/lib/square/http/http_method_enum.rb

@@ -0,0 +1,8 @@
+module Square
+  # HTTP Methods Enumeration.
+  class HttpMethodEnum
+    HTTPMETHODENUM = [GET = 'GET'.freeze, POST = 'POST'.freeze,
+                      PUT = 'PUT'.freeze, PATCH = 'PATCH'.freeze,
+                      DELETE = 'DELETE'.freeze, HEAD = 'HEAD'.freeze].freeze
+  end
+end

data/lib/square/http/http_request.rb

@@ -0,0 +1,45 @@
+module Square
+  # Represents a single Http Request.
+  class HttpRequest
+    attr_accessor :http_method, :query_url, :headers,
+                  :parameters, :username, :password
+
+    # The constructor.
+    # @param [HttpMethodEnum] The HTTP method.
+    # @param [String] The URL to send the request to.
+    # @param [Hash, Optional] The headers for the HTTP Request.
+    # @param [Hash, Optional] The parameters for the HTTP Request.
+    def initialize(http_method,
+                   query_url,
+                   headers: {},
+                   parameters: {})
+      @http_method = http_method
+      @query_url = query_url
+      @headers = headers
+      @parameters = parameters
+    end
+
+    # Add a header to the HttpRequest.
+    # @param [String] The name of the header.
+    # @param [String] The value of the header.
+    def add_header(name, value)
+      @headers[name] = value
+    end
+
+    # Add a parameter to the HttpRequest.
+    # @param [String] The name of the parameter.
+    # @param [String] The value of the parameter.
+    def add_parameter(name, value)
+      @parameters[name] = value
+    end
+
+    # Add a query parameter to the HttpRequest.
+    # @param [String] The name of the query parameter.
+    # @param [String] The value of the query parameter.
+    def add_query_parameter(name, value)
+      @query_url = APIHelper.append_url_with_query_parameters(@query_url,
+                                                              name => value)
+      @query_url = APIHelper.clean_url(@query_url)
+    end
+  end
+end

data/lib/square/http/http_response.rb

@@ -0,0 +1,24 @@
+module Square
+  # Http response received.
+  class HttpResponse
+    attr_reader :status_code, :reason_phrase, :headers, :raw_body, :request
+
+    # The constructor
+    # @param [Integer] The status code returned by the server.
+    # @param [String] The reason phrase returned by the server.
+    # @param [Hash] The headers sent by the server in the response.
+    # @param [String] The raw body of the response.
+    # @param [HttpRequest] The request that resulted in this response.
+    def initialize(status_code,
+                   reason_phrase,
+                   headers,
+                   raw_body,
+                   request)
+      @status_code = status_code
+      @reason_phrase = reason_phrase
+      @headers = headers
+      @raw_body = raw_body
+      @request = request
+    end
+  end
+end

data/lib/square/utilities/file_wrapper.rb

@@ -0,0 +1,12 @@
+module Square
+  # A utility to allow users to set the content-type for files
+  class FileWrapper
+    attr_reader :content_type
+    attr_reader :file
+
+    def initialize(file, content_type: 'application/octet-stream')
+      @file = file
+      @content_type = content_type
+    end
+  end
+end