pipedrive.rb 0.1.0

data/lib/pipedrive/deal.rb

@@ -0,0 +1,8 @@
+module Pipedrive
+  class Deal < Base
+    include ::Pipedrive::Operations::Create
+    include ::Pipedrive::Operations::Read
+    include ::Pipedrive::Operations::Update
+    include ::Pipedrive::Operations::Delete
+  end
+end

data/lib/pipedrive/deal_field.rb

@@ -0,0 +1,11 @@
+module Pipedrive
+  class DealField < Base
+    include ::Pipedrive::Operations::Create
+    include ::Pipedrive::Operations::Read
+    include ::Pipedrive::Operations::Delete
+
+    def entity_name
+      'dealFields'
+    end
+  end
+end

data/lib/pipedrive/file.rb

@@ -0,0 +1,8 @@
+module Pipedrive
+  class File < Base
+    include ::Pipedrive::Operations::Create
+    include ::Pipedrive::Operations::Read
+    include ::Pipedrive::Operations::Update
+    include ::Pipedrive::Operations::Delete
+  end
+end

data/lib/pipedrive/filter.rb

@@ -0,0 +1,6 @@
+module Pipedrive
+  class Filter < Base
+    include ::Pipedrive::Operations::Read
+    include ::Pipedrive::Operations::Delete
+  end
+end

data/lib/pipedrive/goal.rb

@@ -0,0 +1,8 @@
+module Pipedrive
+  class Goal < Base
+    include ::Pipedrive::Operations::Create
+    include ::Pipedrive::Operations::Read
+    include ::Pipedrive::Operations::Update
+    include ::Pipedrive::Operations::Delete
+  end
+end

data/lib/pipedrive/note.rb

@@ -0,0 +1,8 @@
+module Pipedrive
+  class Note < Base
+    include ::Pipedrive::Operations::Create
+    include ::Pipedrive::Operations::Read
+    include ::Pipedrive::Operations::Update
+    include ::Pipedrive::Operations::Delete
+  end
+end

data/lib/pipedrive/operations/create.rb

@@ -0,0 +1,11 @@
+module Pipedrive
+  module Operations
+    module Create
+      extend ActiveSupport::Concern
+
+      def create(params)
+        make_api_call(:post, params)
+      end
+    end
+  end
+end

data/lib/pipedrive/operations/delete.rb

@@ -0,0 +1,15 @@
+module Pipedrive
+  module Operations
+    module Delete
+      extend ActiveSupport::Concern
+
+      def delete(id)
+        make_api_call(:delete, id)
+      end
+
+      def delete_all
+        make_api_call(:delete)
+      end
+    end
+  end
+end

data/lib/pipedrive/operations/read.rb

@@ -0,0 +1,29 @@
+module Pipedrive
+  module Operations
+    module Read
+      extend ActiveSupport::Concern
+      include ::Enumerable
+      include ::Pipedrive::Utils
+
+      # This method smells of :reek:TooManyStatements but ignores them
+      def each(params = {})
+        return to_enum(:each, params) unless block_given?
+        follow_pagination(:chunk, [], params) { |item| yield item }
+      end
+
+      def all(params = {})
+        each(params).to_a
+      end
+
+      def chunk(params = {})
+        res = make_api_call(:get, params)
+        return [] unless res.success?
+        res
+      end
+
+      def find_by_id(id)
+        make_api_call(:get, id)
+      end
+    end
+  end
+end

data/lib/pipedrive/operations/update.rb

@@ -0,0 +1,15 @@
+module Pipedrive
+  module Operations
+    module Update
+      extend ActiveSupport::Concern
+
+      def update(*args)
+        params = args.extract_options!
+        params.symbolize_keys!
+        id = params.delete(:id) || args[0]
+        fail 'id must be provided' unless id
+        make_api_call(:put, id, params)
+      end
+    end
+  end
+end

data/lib/pipedrive/organization.rb

@@ -0,0 +1,8 @@
+module Pipedrive
+  class Organization < Base
+    include ::Pipedrive::Operations::Read
+    include ::Pipedrive::Operations::Create
+    include ::Pipedrive::Operations::Update
+    include ::Pipedrive::Operations::Delete
+  end
+end

data/lib/pipedrive/organization_field.rb

@@ -0,0 +1,11 @@
+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,18 @@
+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)
+      params = args.extract_options!
+      params[:term] ||= args[0]
+      fail '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) { |item| yield item }
+    end
+  end
+end

data/lib/pipedrive/person_field.rb

@@ -0,0 +1,11 @@
+module Pipedrive
+  class PersonField < Base
+    include ::Pipedrive::Operations::Read
+    include ::Pipedrive::Operations::Create
+    include ::Pipedrive::Operations::Delete
+
+    def entity_name
+      'personFields'
+    end
+  end
+end

data/lib/pipedrive/product.rb

@@ -0,0 +1,8 @@
+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,11 @@
+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,7 @@
+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,8 @@
+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,8 @@
+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/utils.rb

@@ -0,0 +1,18 @@
+module Pipedrive
+  module Utils
+    extend ActiveSupport::Concern
+
+    def follow_pagination(method, args, params)
+      start = params[:start] || 0
+      loop do
+        res = __send__(method, *args, params.merge(start: start))
+        break if !res.try(:data) || !res.success?
+        res.data.each do |item|
+          yield item
+        end
+        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,3 @@
+module Pipedrive
+  VERSION = '0.1.0'
+end

data/pipedrive.gemspec

@@ -0,0 +1,29 @@
+# encoding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pipedrive/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "pipedrive.rb"
+  gem.version       = Pipedrive::VERSION
+  gem.authors       = ["Alexander Simonov"]
+  gem.email         = ["alex@simonov.me"]
+  gem.summary       = %q{Pipedrive.com API Wrapper}
+  gem.description   = %q{Pipedrive.com API Wrapper}
+  gem.homepage      = 'https://github.com/dotpromo/pipedrive.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.add_dependency('faraday')
+  gem.add_dependency('faraday_middleware')
+  gem.add_dependency('activesupport', '>= 4.0.0')
+  gem.add_dependency('hashie', '>= 3.0')
+  gem.add_development_dependency('bundler', '~> 1.6')
+  gem.add_development_dependency('rake')
+  gem.add_development_dependency('rspec', '>= 3.0')
+  gem.add_development_dependency('webmock')
+end

data/spec/lib/pipedrive/activity_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+
+RSpec.describe ::Pipedrive::Activity do
+  subject { described_class.new('token') }
+  context '#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,9 @@
+require 'spec_helper'
+
+RSpec.describe ::Pipedrive::ActivityType do
+  subject { described_class.new('token') }
+  context '#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,122 @@
+require 'spec_helper'
+
+RSpec.describe ::Pipedrive::Base do
+  subject { described_class.new('token') }
+  context '#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 { is_expected.to eq({
+      url:     'https://api.pipedrive.com',
+      headers: { accept: 'application/json', user_agent: 'Pipedrive Ruby Client v0.0.1' }
+    }) }
+  end
+
+  context '::connection' do
+    subject { super().connection }
+    it { is_expected.to be_kind_of(::Faraday::Connection) }
+  end
+
+  context '#failed_response' do
+    let(:res) { double('res', body: ::Hashie::Mash.new({}), status: status) }
+    subject { super().failed_response(res) }
+    context 'status is 401' do
+      let(:status) { 401 }
+      it { is_expected.to eq(::Hashie::Mash.new({
+                                                  failed:         false,
+                                                  not_authorized: true,
+                                                  success:        false
+                                                })) }
+    end
+    context 'status is 420' do
+      let(:status) { 420 }
+      it { is_expected.to eq(::Hashie::Mash.new({
+                                                  failed:         true,
+                                                  not_authorized: false,
+                                                  success:        false
+                                                })) }
+    end
+    context 'status is 400' do
+      let(:status) { 400 }
+      it { is_expected.to eq(::Hashie::Mash.new({
+                                                  failed:         false,
+                                                  not_authorized: false,
+                                                  success:        false
+                                                })) }
+    end
+  end
+  context '#make_api_call' do
+    it 'should failed no method' do
+      expect { subject.make_api_call(test: 'foo') }.to raise_error('method param missing')
+    end
+    context 'without id' do
+      it 'should call :get' do
+        stub_request(:get, 'https://api.pipedrive.com/v1/bases?api_token=token').to_return(:status => 200, :body => {}, :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 'should call :post' do
+        stub_request(:post, 'https://api.pipedrive.com/v1/bases?api_token=token').to_return(:status => 200, :body => {}, :headers => {})
+        expect_any_instance_of(::Faraday::Connection).to receive(:post).with('/v1/bases?api_token=token', { test: 'bar' }).and_call_original
+        expect(subject.make_api_call(:post, test: 'bar'))
+      end
+      it 'should call :put' do
+        stub_request(:put, 'https://api.pipedrive.com/v1/bases?api_token=token').to_return(:status => 200, :body => {}, :headers => {})
+        expect_any_instance_of(::Faraday::Connection).to receive(:put).with('/v1/bases?api_token=token', { test: 'bar' }).and_call_original
+        expect(subject.make_api_call(:put, test: 'bar'))
+      end
+      it 'should use field_selector properly' do
+        stub_request(:get, 'https://api.pipedrive.com/v1/bases:(a,b,c)?api_token=token').to_return(:status => 200, :body => {}, :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 'should 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 => {}, :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 'should retry if Errno::ETIMEDOUT' do
+        stub_request(:get, 'https://api.pipedrive.com/v1/bases?api_token=token').to_return(:status => 200, :body => {}, :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 'should call :get' do
+        stub_request(:get, 'https://api.pipedrive.com/v1/bases/12?api_token=token').to_return(:status => 200, :body => {}, :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 'should call :post' do
+        stub_request(:post, 'https://api.pipedrive.com/v1/bases/13?api_token=token').to_return(:status => 200, :body => {}, :headers => {})
+        expect_any_instance_of(::Faraday::Connection).to receive(:post).with('/v1/bases/13?api_token=token', { test: 'bar' }).and_call_original
+        expect(subject.make_api_call(:post, 13, test: 'bar'))
+      end
+      it 'should call :put' do
+        stub_request(:put, 'https://api.pipedrive.com/v1/bases/14?api_token=token').to_return(:status => 200, :body => {}, :headers => {})
+        expect_any_instance_of(::Faraday::Connection).to receive(:put).with('/v1/bases/14?api_token=token', { test: 'bar' }).and_call_original
+        expect(subject.make_api_call(:put, 14, test: 'bar'))
+      end
+    end
+    it 'should call 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 'should call #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,9 @@
+require 'spec_helper'
+
+RSpec.describe ::Pipedrive::DealField do
+  subject { described_class.new('token') }
+  context '#entity_name' do
+    subject { super().entity_name }
+    it { is_expected.to eq('dealFields') }
+  end
+end