basecrm 0.1.2 → 1.0.0

data/lib/basecrm/configuration.rb

@@ -0,0 +1,59 @@
+require 'uri'
+
+module BaseCRM
+  class Configuration
+    attr_reader :access_token
+    attr_reader :base_url
+    attr_reader :user_agent
+    attr_reader :timeout
+    attr_reader :verify_ssl
+
+    attr_reader :logger, :verbose
+    alias_method :debug?, :verbose
+
+    def initialize(options={})
+      @access_token = options[:access_token]
+      @base_url = options[:base_url] || "https://api.getbase.com"
+      @user_agent = options[:user_agent] || "BaseCRM/v2 Ruby/#{VERSION}"
+      @logger = options[:logger]
+      @verbose = !!options[:verbose]
+      @timeout = options[:timeout] || 30
+      @verify_ssl = options.fetch(:verify_ssl, true)
+    end
+
+    def validate!
+      unless @access_token
+        raise ConfigurationError.new('No access token provided. '\
+          'Set your access token during client initialization using: '\
+          '"Base::Client.new(access_token: <YOUR_PERSONAL_ACCESS_TOKEN>)".')
+      end
+
+      if @access_token =~ /\s/
+        raise ConfigurationError.new('Provided access token is invalid '\
+          'as it contains disallowed characters. '\
+          'Please double-check your access token.')
+      end
+
+      if @access_token.length != 64
+        raise ConfigurationError.new('Provided access token is invalid '\
+          'as it has invalid length. '\
+          'Please double-check your access token.')
+
+      end
+
+      unless /\A#{URI.regexp(%w(http https)).to_s}\z/.match(@base_url)
+        raise ConfigurationError.new('Provided base url is invalid '\
+          'as it is not a valid URI. '\
+          'Please make sure it includes the scheme part, both http and https are accepted, '\
+          'and the hierarchical part.')
+      end
+
+    end
+
+    def inspect
+      instance_variables.map { |ivar|
+        "#{ivar}=#{self.instance_variable_get(ivar)}"
+      }.join("\n")
+    end
+  end
+end

data/lib/basecrm/envelope.rb

@@ -0,0 +1,7 @@
+module BaseCRM
+  module Envelope
+    def self.wrap(data)
+      JSON.dump({data: data})
+    end
+  end
+end

data/lib/basecrm/errors.rb

@@ -0,0 +1,65 @@
+module BaseCRM
+  class ConnectionError < StandardError
+  end
+
+  class ConfigurationError < StandardError
+  end
+
+  class BaseError < StandardError
+    attr_reader :code, :message, :details
+
+    def initialize(error)
+      @data = error[:error]
+      @meta = error[:meta]
+
+      @code = @data[:code]
+      @message = @data[:message]
+      @details = @data[:details]
+    end
+
+    def to_s
+      "code=#{@code} message=#{message} details=#{details}"
+    end
+  end
+
+  class RequestError < BaseError
+  end
+
+  class ResourceError < BaseError
+    attr_reader :resource, :field
+
+    def initialize(error)
+      super
+
+      @resource = @data[:resource]
+      @field = @data[:field]
+    end
+
+    def to_s
+      super + " resource=#{@resource} field=#{@field}"
+    end
+  end
+
+  class ServerError < BaseError
+  end
+
+  class ErrorsCollection < StandardError
+    attr_reader :errors
+
+    attr_reader :http_status, :logref
+    alias_method :request_id, :logref
+
+
+    def initialize(errors, meta)
+      @errors = errors
+
+      @http_status = meta[:http_status]
+      @logref = meta[:logref]
+    end
+
+    def to_s
+      status = "[#{@logref}] http_status=#{@http_status}\n"
+      status + @errors.map(&:to_s).join("\n")
+    end
+  end
+end

data/lib/basecrm/http_client.rb

@@ -0,0 +1,91 @@
+require_relative 'middlewares/oauth_bearer_token'
+require_relative 'middlewares/raise_error'
+
+module BaseCRM
+  class HttpClient
+
+    attr_reader :headers
+
+    def initialize(config)
+      @config = config
+
+      @headers = {
+        'User-Agent' => config.user_agent,
+        'Accept' => 'application/json'
+      }
+
+      @api_version = "/v2"
+
+      options = {
+        # timeout: config.timeout
+      }
+      options[:ssl] = { verify: false } unless config.verify_ssl
+
+      @client = Faraday.new(config.base_url, options) do |faraday|
+        faraday.use BaseCRM::Middlewares::OAuthBearerToken, config.access_token
+        faraday.use BaseCRM::Middlewares::RaiseError
+        faraday.response :logger, config.logger if config.debug?
+
+        faraday.adapter Faraday.default_adapter
+      end
+    end
+
+    def get(path, params={})
+      request(:get, path, params)
+    end
+
+    def post(path, body={})
+      request(:post, path, body)
+    end
+
+    def put(path, body={})
+      request(:put, path, body)
+    end
+
+    def delete(path, params={})
+      request(:delete, path, params)
+    end
+
+    def request(method, path, data={})
+      options = {
+        headers: @headers
+      }
+
+      case method.to_s.downcase.to_sym
+      when :get, :head, :delete
+        options[:query] = encode_params(data) unless data.empty?
+      else
+        unless data.empty?
+          options[:headers]['Content-Type'] = 'application/json'
+          options[:body] = Envelope.wrap(data)
+        end
+      end
+
+      path = "#{@api_version}#{path}"
+
+      res = instance_eval <<-RUBY, __FILE__, __LINE__ + 1
+        @client.#{method}(path) do |req|
+          req.body = options[:body] if options[:body]
+          req.headers.update(options[:headers])
+          req.params.update(options[:query]) if options[:query]
+        end
+      RUBY
+
+      [res.status, res.headers, extract_body(res)]
+    rescue Faraday::Error::ConnectionFailed => e
+      raise ConnectionError, e.message
+    end
+
+  private
+    def encode_params(params)
+      params.map { |k, v|
+        v.is_a?(Array) ? [k, v.join(',')] : [k, v]
+      }.to_h
+    end
+
+    def extract_body(res)
+      content_type = res.headers['Content-Type']
+      content_type && content_type.include?('json') ? JSON.parse(res.body, symbolize_names: true) : res.body
+    end
+  end
+end

data/lib/basecrm/middlewares/oauth_bearer_token.rb

@@ -0,0 +1,18 @@
+module BaseCRM
+  module Middlewares
+    class OAuthBearerToken < Faraday::Middleware
+
+      def initialize(app, access_token)
+        super app
+        @access_token = access_token
+      end
+
+
+      def call(env)
+        env[:request_headers]["Authorization"] = "Bearer #{@access_token}"
+        @app.call(env)
+      end
+
+    end
+  end
+end

data/lib/basecrm/middlewares/raise_error.rb

@@ -0,0 +1,31 @@
+module BaseCRM
+  module Middlewares
+    class RaiseError < Faraday::Response::Middleware
+
+      def on_complete(env)
+        status = env[:status]
+        return if (200...300).member?(status)
+
+        content_type = env[:response_headers]['content-type']
+
+        unless content_type.include?('json')
+          raise "status=#{status} error=Unknown error occurred."
+        end
+
+        error_klass = case status
+        when 422 then BaseCRM::ResourceError
+        when 400...500 then BaseCRM::RequestError
+        when 500...600 then BaseCRM::ServerError
+        end
+
+        raise errors_collection(env, error_klass)
+      end
+
+      def errors_collection(env, error_klass)
+        envelope = JSON.parse(env[:body], symbolize_names: true)
+        errors = envelope[:errors]
+        ErrorsCollection.new(errors.map { |e| error_klass.new(e) }, envelope[:meta])
+      end
+    end
+  end
+end

data/lib/basecrm/model.rb

@@ -0,0 +1,6 @@
+require 'ostruct'
+
+module BaseCRM
+  class Model < OpenStruct
+  end
+end

data/lib/basecrm/models/account.rb

@@ -0,0 +1,31 @@
+# WARNING: This code is auto-generated from the BaseCRM API Discovery JSON Schema
+
+module BaseCRM
+  class Account < Model
+    # @!attribute [r] created_at
+    #   @return [DateTime] Date and time of the account's creation in UTC (ISO8601 format).
+    # attr_reader :created_at
+    # @!attribute [r] id
+    #   @return [Integer] Unique identifier of the account.
+    # attr_reader :id
+    # @!attribute [r] updated_at
+    #   @return [DateTime] Date and time of the last update in UTC (ISO8601 format).
+    # attr_reader :updated_at
+
+    # @!attribute [rw] currency
+    #   @return [String] Currency of the account as the 3-character currency code in ISO4217 format.
+    # attr_accessor :currency
+    # @!attribute [rw] name
+    #   @return [String] Full name of the account.
+    # attr_accessor :name
+    # @!attribute [rw] phone
+    #   @return [String] Contact phone number of the account.
+    # attr_accessor :phone
+    # @!attribute [rw] time_format
+    #   @return [String] Time format used for the account. Either 12-hour clock `12H` or 24-hour clock `24H`.
+    # attr_accessor :time_format
+    # @!attribute [rw] timezone
+    #   @return [String] Timezone of the account as the offset from Coordinated Universal Time (UTC) in the format `UTC(+|-)[hh]:[mm]`.
+    # attr_accessor :timezone
+  end
+end

data/lib/basecrm/models/address.rb

@@ -0,0 +1,22 @@
+# WARNING: This code is auto-generated from the BaseCRM API Discovery JSON Schema
+
+module BaseCRM
+  class Address < Model
+
+    # @!attribute [rw] city
+    #   @return [String] City name.
+    # attr_accessor :city
+    # @!attribute [rw] country
+    #   @return [String] Country name.
+    # attr_accessor :country
+    # @!attribute [rw] line1
+    #   @return [String] Line 1 of the address e.g. number, street, suite, apt #, etc.
+    # attr_accessor :line1
+    # @!attribute [rw] postal_code
+    #   @return [String] Zip code or equivalent.
+    # attr_accessor :postal_code
+    # @!attribute [rw] state
+    #   @return [String] State name.
+    # attr_accessor :state
+  end
+end

data/lib/basecrm/models/associated_contact.rb

@@ -0,0 +1,19 @@
+# WARNING: This code is auto-generated from the BaseCRM API Discovery JSON Schema
+
+module BaseCRM
+  class AssociatedContact < Model
+    # @!attribute [r] created_at
+    #   @return [DateTime] Date and time that the associated contact was created in UTC (ISO8601 format).
+    # attr_reader :created_at
+    # @!attribute [r] updated_at
+    #   @return [DateTime] Date and time of the last update on the associated contact in UTC (ISO8601 format).
+    # attr_reader :updated_at
+
+    # @!attribute [rw] contact_id
+    #   @return [Integer] Unique identifier of the contact to be associated with the deal.
+    # attr_accessor :contact_id
+    # @!attribute [rw] role
+    #   @return [String] Role name.
+    # attr_accessor :role
+  end
+end

data/lib/basecrm/models/contact.rb

@@ -0,0 +1,88 @@
+# WARNING: This code is auto-generated from the BaseCRM API Discovery JSON Schema
+
+module BaseCRM
+  class Contact < Model
+    # @!attribute [r] created_at
+    #   @return [DateTime] Date and time that the record was created in UTC ISO8601 format.
+    # attr_reader :created_at
+    # @!attribute [r] creator_id
+    #   @return [Integer] The unique identifier of the user the contact was created by.
+    # attr_reader :creator_id
+    # @!attribute [r] id
+    #   @return [Integer] The unique identifier of the contact.
+    # attr_reader :id
+    # @!attribute [r] updated_at
+    #   @return [DateTime] Date and time of the record's last update in UTC ISO8601 format.
+    # attr_reader :updated_at
+
+    # @!attribute [rw] address
+    #   @return [Address] 
+    # attr_accessor :address
+    # @!attribute [rw] contact_id
+    #   @return [Integer] The unique identifier of the organization the contact belongs to. The field will be set only if the contact is an individual.
+    # attr_accessor :contact_id
+    # @!attribute [rw] custom_fields
+    #   @return [Hash] Custom fields are a key-value pair attached to a contact. See more at [Custom Fields](/docs/rest/articles/requests#custom_fields).
+    # attr_accessor :custom_fields
+    # @!attribute [rw] customer_status
+    #   @return [String] The customer status of the contact.
+    # attr_accessor :customer_status
+    # @!attribute [rw] description
+    #   @return [String] The contact's description.
+    # attr_accessor :description
+    # @!attribute [rw] email
+    #   @return [String] The contact's email address.
+    # attr_accessor :email
+    # @!attribute [rw] facebook
+    #   @return [String] The contact's Facebook nickname.
+    # attr_accessor :facebook
+    # @!attribute [rw] fax
+    #   @return [String] The contact's fax number.
+    # attr_accessor :fax
+    # @!attribute [rw] first_name
+    #   @return [String] First name of the contact.
+    # attr_accessor :first_name
+    # @!attribute [rw] industry
+    #   @return [String] The contact's industry.
+    # attr_accessor :industry
+    # @!attribute [rw] is_organization
+    #   @return [Boolean] Indicator of whether or not this contact refers to an organization or an individual. This value can be set **only** during creation and **cannot** be changed later. The default value is `false`.
+    # attr_accessor :is_organization
+    # @!attribute [rw] last_name
+    #   @return [String] Last name of the contact. Required only if the contact is an individual.
+    # attr_accessor :last_name
+    # @!attribute [rw] linkedin
+    #   @return [String] The contact's Linkedin nickname.
+    # attr_accessor :linkedin
+    # @!attribute [rw] mobile
+    #   @return [String] The contact's mobile phone number.
+    # attr_accessor :mobile
+    # @!attribute [rw] name
+    #   @return [String] Name of the contact. Required only if the contact is an organization.
+    # attr_accessor :name
+    # @!attribute [rw] owner_id
+    #   @return [Integer] The unique identifier of the user the contact is currently assigned to.
+    # attr_accessor :owner_id
+    # @!attribute [rw] phone
+    #   @return [String] The contact's phone number.
+    # attr_accessor :phone
+    # @!attribute [rw] prospect_status
+    #   @return [String] The prospect status of the contact.
+    # attr_accessor :prospect_status
+    # @!attribute [rw] skype
+    #   @return [String] The contact's Skype nickname.
+    # attr_accessor :skype
+    # @!attribute [rw] tags
+    #   @return [Array<String>] An array of tags for the contact. See more at [Tags](/docs/rest/articles/requests#tags).
+    # attr_accessor :tags
+    # @!attribute [rw] title
+    #   @return [String] The contact's job title.
+    # attr_accessor :title
+    # @!attribute [rw] twitter
+    #   @return [String] The contact's Twitter handle.
+    # attr_accessor :twitter
+    # @!attribute [rw] website
+    #   @return [String] The contact's website address.
+    # attr_accessor :website
+  end
+end