paperdrive 0.0.5

data/lib/paperdrive/client.rb

@@ -0,0 +1,122 @@
+# frozen_string_literal: true
+
+require 'active_support'
+require 'active_support/core_ext'
+require 'faraday'
+require 'faraday_middleware'
+require 'paperdrive/error'
+require 'paperdrive/parameters'
+require 'paperdrive/response'
+require 'paperdrive/client/activities'
+require 'paperdrive/client/activity_fields'
+require 'paperdrive/client/activity_types'
+require 'paperdrive/client/currencies'
+require 'paperdrive/client/deals'
+require 'paperdrive/client/deal_fields'
+require 'paperdrive/client/filters'
+require 'paperdrive/client/global_messages'
+require 'paperdrive/client/mail_messages'
+require 'paperdrive/client/mail_threads'
+require 'paperdrive/client/notes'
+require 'paperdrive/client/note_fields'
+require 'paperdrive/client/organizations'
+require 'paperdrive/client/organization_fields'
+require 'paperdrive/client/organization_relationships'
+require 'paperdrive/client/permission_sets'
+require 'paperdrive/client/persons'
+require 'paperdrive/client/person_fields'
+require 'paperdrive/client/pipelines'
+require 'paperdrive/client/product_fields'
+require 'paperdrive/client/products'
+require 'paperdrive/client/recents'
+require 'paperdrive/client/roles'
+require 'paperdrive/client/search_results'
+require 'paperdrive/client/stages'
+require 'paperdrive/client/users'
+require 'paperdrive/client/user_connections'
+require 'paperdrive/client/user_settings'
+require 'paperdrive/client/webhooks'
+
+module Paperdrive
+  # Client to aceess API
+  class Client
+    include Paperdrive::Client::Activities
+    include Paperdrive::Client::ActivityFields
+    include Paperdrive::Client::ActivityTypes
+    include Paperdrive::Client::Currencies
+    include Paperdrive::Client::Deals
+    include Paperdrive::Client::DealFields
+    include Paperdrive::Client::Filters
+    include Paperdrive::Client::GlobalMessages
+    include Paperdrive::Client::MailMessages
+    include Paperdrive::Client::MailThreads
+    include Paperdrive::Client::Notes
+    include Paperdrive::Client::NoteFields
+    include Paperdrive::Client::Organizations
+    include Paperdrive::Client::OrganizationFields
+    include Paperdrive::Client::OrganizationRelationships
+    include Paperdrive::Client::PermissionSets
+    include Paperdrive::Client::Persons
+    include Paperdrive::Client::PersonFields
+    include Paperdrive::Client::Pipelines
+    include Paperdrive::Client::ProductFields
+    include Paperdrive::Client::Products
+    include Paperdrive::Client::Recents
+    include Paperdrive::Client::Roles
+    include Paperdrive::Client::SearchResults
+    include Paperdrive::Client::Stages
+    include Paperdrive::Client::Users
+    include Paperdrive::Client::UserConnections
+    include Paperdrive::Client::UserSettings
+    include Paperdrive::Client::Webhooks
+
+    API_BASEURL = 'https://api.pipedrive.com/v1'
+
+    # build instances by<br>
+    # using arguments: pass the token as `token:`<br>
+    # or using environment variables: set the token to ENV['PAPERDRIVE_TOKEN']
+    #
+    # @param [String] token: Paperdrive API access token
+    # @return [Paperdrive::Client] instance
+    def initialize(token: nil)
+      token ||= ENV['PAPERDRIVE_TOKEN']
+      raise Paperdrive::AuthTokenNotSpecified unless token || token.is_a?(String)
+
+      @token = token
+    end
+
+    # masking tokens to prevent casually displaying tokens
+    #
+    # @return [String] inspected and token masked string
+    def inspect
+      inspected = super
+      inspected.gsub!(@token, 'MASKED_TOKEN') if @token
+    end
+
+    protected
+
+    # make crud request
+    def request(method, path, params)
+      raise Paperdrive::InvalidRequestMethod unless %i[get post put delete].include?(method.to_sym)
+
+      raw_response = connection.send(method, build_path(path), params)
+      Paperdrive::Response.new(raw_response)
+    end
+
+    private
+
+    # memonize Faraday connection
+    def connection
+      @connection ||= Faraday.new(url: API_BASEURL) do |faraday|
+        faraday.request :json
+        faraday.response :logger
+        faraday.adapter Faraday.default_adapter
+      end
+    end
+
+    # build path which has `api_token:` query param
+    def build_path(path)
+      "#{path}?#{{ api_token: @token }.to_query}"
+    end
+  end
+end

data/lib/paperdrive/error.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Paperdrive
+  # Error Class
+  class Error < StandardError
+    class << self
+      # raise errors which corresponding to response status code
+      #
+      # @param [Paperdrive::Client] response
+      def raise_from(response)
+        status = response.status
+        return if (200..299).cover?(status)
+
+        klass = case status
+                when 400 then Paperdrive::BadRequest
+                when 401 then Paperdrive::Unauthorized
+                when 429 then Paperdrive::RateLimitExceeded
+                when 400..499 then Paperdrive::ClientError
+                when 500 then Paperdrive::InternalServerError
+                when 500..599 then Paperdrive::ServerError
+                else Paperdrive::UnknownError
+                end
+        raise klass, "#{status}-#{response&.reason_phrase}"
+      end
+    end
+  end
+
+  # response-relateds
+  class ClientError < Error; end
+  class BadRequest < ClientError; end
+  class Unautorized < ClientError; end
+  class RateLimitExceeded < ClientError; end
+  class ServerError < Error; end
+  class InternalServerError < ServerError; end
+  class UnknownError < Error; end
+
+  # others
+  class AuthTokenNotSpecified < Error; end
+  class InvalidRequiredParameters < Error; end
+  class MissingRequiredParameters < Error; end
+  class InvalidRequestMethod < Error; end
+end

data/lib/paperdrive/parameters.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require 'active_support'
+require 'active_support/core_ext'
+require 'paperdrive/error'
+
+module Paperdrive
+  # Module which has methods to define parameters to submit with request
+  module Parameters
+    protected
+
+    def parameters(params, &_block)
+      @params = params.symbolize_keys
+      yield if block_given?
+      @params
+    end
+
+    # set required parameters and raise errors if there are lack of params
+    def required_params(*args)
+      raise InvalidRequiredParameters unless args.all? { |arg| arg.is_a?(Symbol) }
+      raise MissingRequiredParameters unless args.all? { |arg| !@params[arg].nil? }
+    end
+
+    # set optional(possible) parameters and output redundant parameters to stdout
+    def optional_params(*args)
+      raise InvalidRequiredParameters unless args.all? { |arg| arg.is_a?(Symbol) }
+
+      @params.keys.each do |key|
+        puts ":#{key} is unused parameter." unless args.include?(key)
+      end
+      @params.slice!(*args)
+    end
+  end
+end

data/lib/paperdrive/response.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'paperdrive/error'
+
+module Paperdrive
+  # Wrapper class of the Faraday::Response.
+  class Response
+    attr_accessor :header, :ratelimit, :body, :status_code, :status_phrase
+
+    # build instance from Faraday::Response
+    #
+    # @param [Faraday::Response] response
+    def initialize(response)
+      Paperdrive::Error.raise_from(response)
+      @header = response.headers.to_h
+      @ratelimit = build_ratelimit(@header)
+      @body = JSON.parse(response.body)
+      @status_code = response.status
+      @status_phrase = response.reason_phrase
+    end
+
+    # return whether the request was successfully processed or not
+    #
+    # @param [boolean]
+    def success?
+      !!@body['success']
+    end
+
+    private
+
+    # build Struct of rate limit information from Faraday::Utils::Headers
+    #
+    # @param [Faraday::Utils::Headers] header response header
+    # @return [Struct<integer>] which has :limit :remain :reset
+    def build_ratelimit(header)
+      Struct.new(:limit, :remain, :reset)
+            .new(header['x-ratelimit-limit'].to_i,
+                 header['x-ratelimit-remaining'].to_i,
+                 header['x-ratelimit-reset'].to_i)
+    end
+  end
+end

data/lib/paperdrive/version.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+# Version Module
+module Paperdrive
+  VERSION = '0.0.5'
+end

data/lib/paperdrive.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require 'paperdrive/version'
+require 'paperdrive/client'
+
+module Paperdrive
+end

data/paperdrive.gemspec

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'paperdrive/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'paperdrive'
+  spec.version       = Paperdrive::VERSION
+  spec.authors       = %w[rnitta]
+  spec.email         = ['attinyes@gmail.com']
+
+  spec.summary       = 'Unofficial Pipedrive API wrapper gem'
+  spec.description   = 'Unofficial Ruby wrapper for the Pipedrive API'
+  spec.homepage      = 'https://github.com/rnitta/paperdrive'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = %w[lib]
+
+  spec.add_dependency 'activesupport'
+  spec.add_dependency 'faraday', '~> 0.15.4'
+  spec.add_dependency 'faraday_middleware', '~> 0.12.2'
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.62.0'
+  spec.add_development_dependency 'yard'
+end

metadata

@@ -0,0 +1,203 @@
+--- !ruby/object:Gem::Specification
+name: paperdrive
+version: !ruby/object:Gem::Version
+  version: 0.0.5
+platform: ruby
+authors:
+- rnitta
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-01-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.15.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.15.4
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.2
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !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: 0.62.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.62.0
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Unofficial Ruby wrapper for the Pipedrive API
+email:
+- attinyes@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/paperdrive.rb
+- lib/paperdrive/client.rb
+- lib/paperdrive/client/activities.rb
+- lib/paperdrive/client/activity_fields.rb
+- lib/paperdrive/client/activity_types.rb
+- lib/paperdrive/client/currencies.rb
+- lib/paperdrive/client/deal_fields.rb
+- lib/paperdrive/client/deals.rb
+- lib/paperdrive/client/filters.rb
+- lib/paperdrive/client/global_messages.rb
+- lib/paperdrive/client/mail_messages.rb
+- lib/paperdrive/client/mail_threads.rb
+- lib/paperdrive/client/note_fields.rb
+- lib/paperdrive/client/notes.rb
+- lib/paperdrive/client/organization_fields.rb
+- lib/paperdrive/client/organization_relationships.rb
+- lib/paperdrive/client/organizations.rb
+- lib/paperdrive/client/permission_sets.rb
+- lib/paperdrive/client/person_fields.rb
+- lib/paperdrive/client/persons.rb
+- lib/paperdrive/client/pipelines.rb
+- lib/paperdrive/client/product_fields.rb
+- lib/paperdrive/client/products.rb
+- lib/paperdrive/client/recents.rb
+- lib/paperdrive/client/roles.rb
+- lib/paperdrive/client/search_results.rb
+- lib/paperdrive/client/stages.rb
+- lib/paperdrive/client/user_connections.rb
+- lib/paperdrive/client/user_settings.rb
+- lib/paperdrive/client/users.rb
+- lib/paperdrive/client/webhooks.rb
+- lib/paperdrive/error.rb
+- lib/paperdrive/parameters.rb
+- lib/paperdrive/response.rb
+- lib/paperdrive/version.rb
+- paperdrive.gemspec
+homepage: https://github.com/rnitta/paperdrive
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Unofficial Pipedrive API wrapper gem
+test_files: []