pipedrive_api_rb 1.0.0

data/lib/pipedrive/organization_field.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Pipedrive
+  class OrganizationField < Base
+    include ::Pipedrive::Operations::Read
+    include ::Pipedrive::Operations::Create
+    include ::Pipedrive::Operations::Delete
+
+    def entity_name
+      'organizationFields'
+    end
+  end
+end

data/lib/pipedrive/person.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Pipedrive
+  class Person < Base
+    include ::Pipedrive::Operations::Read
+    include ::Pipedrive::Operations::Create
+    include ::Pipedrive::Operations::Update
+    include ::Pipedrive::Operations::Delete
+    include ::Pipedrive::Utils
+
+    def find_by_name(*args, &block)
+      params = args.extract_options!
+      params[:term] ||= args[0]
+      raise 'term is missing' unless params[:term]
+
+      params[:search_by_email] ||= args[1] ? 1 : 0
+      return to_enum(:find_by_name, params) unless block_given?
+
+      follow_pagination(:make_api_call, [:get, 'find'], params, &block)
+    end
+  end
+end

data/lib/pipedrive/person_field.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Pipedrive
+  class PersonField < Base
+    include ::Pipedrive::Operations::Read
+    include ::Pipedrive::Operations::Create
+    include ::Pipedrive::Operations::Update
+    include ::Pipedrive::Operations::Delete
+
+    def entity_name
+      'personFields'
+    end
+  end
+end

data/lib/pipedrive/pipeline.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Pipedrive
+  class Pipeline < Base
+    include ::Pipedrive::Operations::Create
+    include ::Pipedrive::Operations::Read
+    include ::Pipedrive::Operations::Update
+    include ::Pipedrive::Operations::Delete
+  end
+end

data/lib/pipedrive/product.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Pipedrive
+  class Product < Base
+    include ::Pipedrive::Operations::Read
+    include ::Pipedrive::Operations::Create
+    include ::Pipedrive::Operations::Update
+    include ::Pipedrive::Operations::Delete
+  end
+end

data/lib/pipedrive/product_field.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Pipedrive
+  class ProductField < Base
+    include ::Pipedrive::Operations::Read
+    include ::Pipedrive::Operations::Create
+    include ::Pipedrive::Operations::Delete
+
+    def entity_name
+      'productFields'
+    end
+  end
+end

data/lib/pipedrive/railties.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Pipedrive
+  class Railties < ::Rails::Railtie
+    initializer 'Pipedrive logger' do
+      ::Pipedrive.logger = ::Rails.logger
+    end
+  end
+end

data/lib/pipedrive/role.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Pipedrive
+  class Role < Base
+    include ::Pipedrive::Operations::Create
+    include ::Pipedrive::Operations::Read
+    include ::Pipedrive::Operations::Update
+    include ::Pipedrive::Operations::Delete
+  end
+end

data/lib/pipedrive/stage.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Pipedrive
+  class Stage < Base
+    include ::Pipedrive::Operations::Create
+    include ::Pipedrive::Operations::Read
+    include ::Pipedrive::Operations::Update
+    include ::Pipedrive::Operations::Delete
+  end
+end

data/lib/pipedrive/user.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Pipedrive
+  class User < Base
+    include ::Pipedrive::Operations::Create
+    include ::Pipedrive::Operations::Read
+    include ::Pipedrive::Operations::Update
+    include ::Pipedrive::Operations::Delete
+  end
+end

data/lib/pipedrive/utils.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Pipedrive
+  module Utils
+    extend ActiveSupport::Concern
+
+    def follow_pagination(method, args, params, &block)
+      start = params[:start] || 0
+      loop do
+        res = __send__(method, *args, params.merge(start: start))
+        break if !res.try(:data) || !res.success?
+
+        res.data.each(&block)
+        break unless res.try(:additional_data).try(:pagination).try(:more_items_in_collection?)
+
+        start = res.try(:additional_data).try(:pagination).try(:next_start)
+      end
+    end
+  end
+end

data/lib/pipedrive/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Pipedrive
+  VERSION = '1.0.0'
+end

data/lib/pipedrive.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+require 'logger'
+require 'active_support/core_ext/hash'
+require 'active_support/concern'
+require 'active_support/inflector'
+
+require 'hashie'
+require 'faraday'
+require 'faraday/mashify'
+require 'pipedrive/version'
+
+module Pipedrive
+  extend self
+  attr_accessor :api_token, :debug
+  attr_writer :user_agent, :logger
+
+  # ensures the setup only gets run once
+  @_ran_once = false
+
+  def reset!
+    @logger = nil
+    @_ran_once = false
+    @user_agent = nil
+    @api_token = nil
+  end
+
+  def user_agent
+    @user_agent ||= "Pipedrive Ruby Client v#{::Pipedrive::VERSION}"
+  end
+
+  def setup
+    yield self unless @_ran_once
+    @_ran_once = true
+  end
+
+  def logger
+    @logger ||= Logger.new($stdout)
+  end
+
+  reset!
+end
+
+require 'pipedrive/railties' if defined?(::Rails)
+
+# Core
+require 'pipedrive/base'
+require 'pipedrive/utils'
+require 'pipedrive/operations/create'
+require 'pipedrive/operations/read'
+require 'pipedrive/operations/update'
+require 'pipedrive/operations/delete'
+
+# Persons
+require 'pipedrive/person_field'
+require 'pipedrive/person'
+
+# Organizations
+require 'pipedrive/organization_field'
+require 'pipedrive/organization'
+
+# Filters
+require 'pipedrive/filter'
+
+# Products
+require 'pipedrive/product_field'
+require 'pipedrive/product'
+
+# Roles
+require 'pipedrive/role'
+
+# Stages
+require 'pipedrive/stage'
+
+# Goals
+require 'pipedrive/goal'
+
+# Activities
+require 'pipedrive/activity'
+require 'pipedrive/activity_type'
+
+# Deals
+require 'pipedrive/deal_field'
+require 'pipedrive/deal'
+
+# Lead
+require 'pipedrive/lead_label'
+require 'pipedrive/lead'
+
+# Files
+require 'pipedrive/file'
+
+# Notes
+require 'pipedrive/note'
+
+# Users
+require 'pipedrive/user'
+
+# Pipelines
+require 'pipedrive/pipeline'

data/pipedrive.gemspec

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pipedrive/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = 'pipedrive_api_rb'
+  gem.version       = Pipedrive::VERSION
+  gem.authors       = ['Jan Sterba', 'Alexander Simonov']
+  gem.email         = ['info@jansterba.com']
+  gem.summary       = 'Pipedrive.com API Wrapper'
+  gem.description   = 'Pipedrive.com API Wrapper'
+  gem.homepage      = 'https://github.com/honzasterba/pipedrive_api_rb'
+  gem.license       = 'MIT'
+
+  gem.files         = `git ls-files -z`.split("\x0")
+  gem.executables   = gem.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ['lib']
+  gem.required_ruby_version = '>=2.5'
+
+  gem.add_dependency('activesupport', '>= 4.0.0')
+  gem.add_dependency('faraday')
+  gem.add_dependency('faraday-mashify')
+  gem.add_dependency('hashie', '>= 3.0')
+  gem.add_development_dependency('bundler')
+  gem.add_development_dependency('rake', '> 12')
+  gem.add_development_dependency('rspec', '>= 3.0')
+  gem.add_development_dependency('rubocop')
+  gem.add_development_dependency('rubocop-performance')
+  gem.add_development_dependency('rubocop-rspec')
+  gem.add_development_dependency('webmock')
+end

data/spec/lib/pipedrive/activity_spec.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe ::Pipedrive::Activity do
+  subject { described_class.new('token') }
+
+  describe '#entity_name' do
+    subject { super().entity_name }
+
+    it { is_expected.to eq('activities') }
+  end
+end

data/spec/lib/pipedrive/activity_type_spec.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe ::Pipedrive::ActivityType do
+  subject { described_class.new('token') }
+
+  describe '#entity_name' do
+    subject { super().entity_name }
+
+    it { is_expected.to eq('activityTypes') }
+  end
+end

data/spec/lib/pipedrive/base_spec.rb

@@ -0,0 +1,155 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe ::Pipedrive::Base do
+  subject { described_class.new('token') }
+
+  describe '#entity_name' do
+    subject { super().entity_name }
+
+    it { is_expected.to eq described_class.name.split('::')[-1].downcase.pluralize }
+  end
+
+  context '::faraday_options' do
+    subject { described_class.faraday_options }
+
+    it {
+      expect(subject).to eq({
+        url:     'https://api.pipedrive.com',
+        headers: { accept: 'application/json', content_type: "application/json", user_agent: 'Pipedrive Ruby Client v0.3.0' }
+        })
+      }
+    end
+
+  context '::connection' do
+    subject { super().connection }
+
+    it { is_expected.to be_kind_of(::Faraday::Connection) }
+  end
+
+  describe '#failed_response' do
+    subject { super().failed_response(res) }
+
+    let(:res) { double('res', body: ::Hashie::Mash.new({}), status: status) }
+
+    context 'status is 401' do
+      let(:status) { 401 }
+
+      it {
+        expect(subject).to eq(::Hashie::Mash.new({
+                                                   failed:         false,
+                                                  not_authorized: true,
+                                                  success:        false
+                                                 }))
+      }
+    end
+
+    context 'status is 420' do
+      let(:status) { 420 }
+
+      it {
+        expect(subject).to eq(::Hashie::Mash.new({
+                                                   failed:         true,
+                                                  not_authorized: false,
+                                                  success:        false
+                                                 }))
+      }
+    end
+
+    context 'status is 400' do
+      let(:status) { 400 }
+
+      it {
+        expect(subject).to eq(::Hashie::Mash.new({
+                                                   failed:         false,
+                                                  not_authorized: false,
+                                                  success:        false
+                                                 }))
+      }
+    end
+  end
+
+  describe '#make_api_call' do
+    it 'faileds no method' do
+      expect { subject.make_api_call(test: 'foo') }.to raise_error('method param missing')
+    end
+
+    context 'without id' do
+      it 'calls :get' do
+        stub_request(:get, 'https://api.pipedrive.com/v1/bases?api_token=token').to_return(status: 200, body: {}.to_json, headers: {})
+        expect_any_instance_of(::Faraday::Connection).to receive(:get).with('/v1/bases?api_token=token', {}).and_call_original
+        expect(subject.make_api_call(:get))
+      end
+
+      it 'calls :post' do
+        stub_request(:post, 'https://api.pipedrive.com/v1/bases?api_token=token').to_return(status: 200, body: {}.to_json, headers: {})
+        expect_any_instance_of(::Faraday::Connection).to receive(:post).with('/v1/bases?api_token=token', { test: 'bar' }.to_json).and_call_original
+        expect(subject.make_api_call(:post, test: 'bar'))
+      end
+
+      it 'calls :put' do
+        stub_request(:put, 'https://api.pipedrive.com/v1/bases?api_token=token').to_return(status: 200, body: {}.to_json, headers: {})
+        expect_any_instance_of(::Faraday::Connection).to receive(:put).with('/v1/bases?api_token=token', { test: 'bar' }.to_json).and_call_original
+        expect(subject.make_api_call(:put, test: 'bar'))
+      end
+
+      it 'uses field_selector properly' do
+        stub_request(:get, 'https://api.pipedrive.com/v1/bases:(a,b,c)?api_token=token').to_return(status: 200, body: {}.to_json, headers: {})
+        expect_any_instance_of(::Faraday::Connection).to receive(:get)
+          .with('/v1/bases:(a,b,c)?api_token=token', {}).and_call_original
+        expect(subject.make_api_call(:get, fields_to_select: %w[a b c]))
+      end
+
+      it 'does not use field_selector if it empty' do
+        stub_request(:get, 'https://api.pipedrive.com/v1/bases?api_token=token').to_return(status: 200, body: {}.to_json, headers: {})
+        expect_any_instance_of(::Faraday::Connection).to receive(:get)
+          .with('/v1/bases?api_token=token', {}).and_call_original
+        expect(subject.make_api_call(:get, fields_to_select: []))
+      end
+
+      it 'retries if Errno::ETIMEDOUT' do
+        stub_request(:get, 'https://api.pipedrive.com/v1/bases?api_token=token').to_return(status: 200, body: {}.to_json, headers: {})
+        connection = subject.connection
+        allow(subject).to receive(:connection).and_return(connection)
+        allow(connection).to receive(:get)
+          .with('/v1/bases?api_token=token', {}).and_raise(Errno::ETIMEDOUT)
+        expect(connection).to receive(:get)
+          .with('/v1/bases?api_token=token', {}).and_call_original
+        expect(subject.make_api_call(:get, fields_to_select: []))
+      end
+    end
+
+    context 'with id' do
+      it 'calls :get' do
+        stub_request(:get, 'https://api.pipedrive.com/v1/bases/12?api_token=token').to_return(status: 200, body: {}.to_json, headers: {})
+        expect_any_instance_of(::Faraday::Connection).to receive(:get).with('/v1/bases/12?api_token=token', {}).and_call_original
+        expect(subject.make_api_call(:get, 12))
+      end
+
+      it 'calls :post' do
+        stub_request(:post, 'https://api.pipedrive.com/v1/bases/13?api_token=token').to_return(status: 200, body: {}.to_json, headers: {})
+        expect_any_instance_of(::Faraday::Connection).to receive(:post).with('/v1/bases/13?api_token=token', { test: 'bar' }.to_json).and_call_original
+        expect(subject.make_api_call(:post, 13, test: 'bar'))
+      end
+
+      it 'calls :put' do
+        stub_request(:put, 'https://api.pipedrive.com/v1/bases/14?api_token=token').to_return(status: 200, body: {}.to_json, headers: {})
+        expect_any_instance_of(::Faraday::Connection).to receive(:put).with('/v1/bases/14?api_token=token', { test: 'bar' }.to_json).and_call_original
+        expect(subject.make_api_call(:put, 14, test: 'bar'))
+      end
+    end
+
+    it 'calls Hashie::Mash if return empty string' do
+      stub_request(:get, 'https://api.pipedrive.com/v1/bases?api_token=token').to_return(status: 200, body: '', headers: {})
+      expect(::Hashie::Mash).to receive(:new).with(success: true).and_call_original
+      expect(subject.make_api_call(:get))
+    end
+
+    it 'calls #failed_response if failed status' do
+      stub_request(:get, 'https://api.pipedrive.com/v1/bases?api_token=token').to_return(status: 400, body: '', headers: {})
+      expect(subject).to receive(:failed_response)
+      expect(subject.make_api_call(:get))
+    end
+  end
+end

data/spec/lib/pipedrive/deal_field_spec.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe ::Pipedrive::DealField do
+  subject { described_class.new('token') }
+
+  describe '#entity_name' do
+    subject { super().entity_name }
+
+    it { is_expected.to eq('dealFields') }
+  end
+end

data/spec/lib/pipedrive/deal_spec.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe ::Pipedrive::Deal do
+  subject { described_class.new('token') }
+
+  describe '#entity_name' do
+    subject { super().entity_name }
+
+    it { is_expected.to eq('deals') }
+  end
+end

data/spec/lib/pipedrive/file_spec.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe ::Pipedrive::File do
+  subject { described_class.new('token') }
+
+  describe '#entity_name' do
+    subject { super().entity_name }
+
+    it { is_expected.to eq('files') }
+  end
+end

data/spec/lib/pipedrive/filter_spec.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe ::Pipedrive::Filter do
+  subject { described_class.new('token') }
+
+  describe '#entity_name' do
+    subject { super().entity_name }
+
+    it { is_expected.to eq('filters') }
+  end
+end

data/spec/lib/pipedrive/goal_spec.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe ::Pipedrive::Goal do
+  subject { described_class.new('token') }
+
+  describe '#entity_name' do
+    subject { super().entity_name }
+
+    it { is_expected.to eq('goals') }
+  end
+end

data/spec/lib/pipedrive/lead_label_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+
+RSpec.describe ::Pipedrive::LeadLabel do
+  subject { described_class.new('token') }
+  context '#entity_name' do
+    subject { super().entity_name }
+    it { is_expected.to eq('leadLabels') }
+  end
+end

data/spec/lib/pipedrive/lead_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+
+RSpec.describe ::Pipedrive::Lead do
+  subject { described_class.new('token') }
+  context '#entity_name' do
+    subject { super().entity_name }
+    it { is_expected.to eq('leads') }
+  end
+end

data/spec/lib/pipedrive/note_spec.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe ::Pipedrive::Note do
+  subject { described_class.new('token') }
+
+  describe '#entity_name' do
+    subject { super().entity_name }
+
+    it { is_expected.to eq('notes') }
+  end
+end

data/spec/lib/pipedrive/ogranization_spec.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe ::Pipedrive::Organization do
+  subject { described_class.new('token') }
+
+  describe '#entity_name' do
+    subject { super().entity_name }
+
+    it { is_expected.to eq('organizations') }
+  end
+end

data/spec/lib/pipedrive/operations/create_spec.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe ::Pipedrive::Operations::Create do
+  subject do
+    Class.new(::Pipedrive::Base) do
+      include ::Pipedrive::Operations::Create
+    end.new('token')
+  end
+
+  describe '#create' do
+    it 'calls #make_api_call' do
+      expect(subject).to receive(:make_api_call).with(:post, { foo: 'bar' })
+      subject.create(foo: 'bar')
+    end
+  end
+end

data/spec/lib/pipedrive/operations/delete_spec.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe ::Pipedrive::Operations::Delete do
+  subject do
+    Class.new(::Pipedrive::Base) do
+      include ::Pipedrive::Operations::Delete
+    end.new('token')
+  end
+
+  describe '#delete' do
+    it 'calls #make_api_call' do
+      expect(subject).to receive(:make_api_call).with(:delete, 12)
+      subject.delete(12)
+    end
+  end
+
+  describe '#delete_all' do
+    it 'calls #make_api_call' do
+      expect(subject).to receive(:make_api_call).with(:delete)
+      subject.delete_all
+    end
+  end
+end