pipedrive.rb 0.2.0 → 0.3.0

data/lib/pipedrive/organization_field.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Pipedrive
   class OrganizationField < Base
     include ::Pipedrive::Operations::Read

data/lib/pipedrive/person.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Pipedrive
   class Person < Base
     include ::Pipedrive::Operations::Read
@@ -6,13 +8,15 @@ module Pipedrive
     include ::Pipedrive::Operations::Delete
     include ::Pipedrive::Utils
 
-    def find_by_name(*args)
+    def find_by_name(*args, &block)
       params = args.extract_options!
       params[:term] ||= args[0]
-      fail 'term is missing' unless params[:term]
+      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) { |item| yield item }
+
+      follow_pagination(:make_api_call, [:get, 'find'], params, &block)
     end
   end
 end

data/lib/pipedrive/person_field.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Pipedrive
   class PersonField < Base
     include ::Pipedrive::Operations::Read

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Pipedrive
   class Product < Base
     include ::Pipedrive::Operations::Read

data/lib/pipedrive/product_field.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Pipedrive
   class ProductField < Base
     include ::Pipedrive::Operations::Read

data/lib/pipedrive/railties.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Pipedrive
   class Railties < ::Rails::Railtie
     initializer 'Pipedrive logger' do

data/lib/pipedrive/role.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Pipedrive
   class Role < Base
     include ::Pipedrive::Operations::Create

data/lib/pipedrive/stage.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Pipedrive
   class Stage < Base
     include ::Pipedrive::Operations::Create

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

@@ -1,16 +1,18 @@
+# frozen_string_literal: true
+
 module Pipedrive
   module Utils
     extend ActiveSupport::Concern
 
-    def follow_pagination(method, args, params)
+    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 do |item|
-          yield item
-        end
+
+        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

data/lib/pipedrive/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Pipedrive
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

data/pipedrive.gemspec

@@ -1,15 +1,16 @@
-# encoding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+# 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.rb"
+  gem.name          = 'pipedrive.rb'
   gem.version       = Pipedrive::VERSION
-  gem.authors       = ["Alexander Simonov"]
-  gem.email         = ["alex@amoniac.eu"]
-  gem.summary       = %q{Pipedrive.com API Wrapper}
-  gem.description   = %q{Pipedrive.com API Wrapper}
+  gem.authors       = ['Alexander Simonov']
+  gem.email         = ['alex@amoniac.eu']
+  gem.summary       = 'Pipedrive.com API Wrapper'
+  gem.description   = 'Pipedrive.com API Wrapper'
   gem.homepage      = 'https://github.com/amoniacou/pipedrive.rb'
   gem.license       = 'MIT'
 
@@ -17,14 +18,17 @@ Gem::Specification.new do |gem|
   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_middleware')
   gem.add_dependency('hashie', '>= 3.0')
   gem.add_development_dependency('bundler')
-  gem.add_development_dependency('rake', '< 12')
+  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

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

data/spec/lib/pipedrive/activity_type_spec.rb

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

data/spec/lib/pipedrive/base_spec.rb

@@ -1,120 +1,153 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 RSpec.describe ::Pipedrive::Base do
   subject { described_class.new('token') }
-  context '#entity_name' do
+
+  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 { is_expected.to eq({
-      url:     'https://api.pipedrive.com',
-      headers: { accept: 'application/json', user_agent: 'Pipedrive Ruby Client v0.1.0' }
-    }) }
+
+    it {
+      expect(subject).to eq({
+                              url:     'https://api.pipedrive.com',
+      headers: { accept: 'application/json', user_agent: 'Pipedrive Ruby Client v0.2.0' }
+                            })
+    }
   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) }
+  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 { is_expected.to eq(::Hashie::Mash.new({
-                                                  failed:         false,
+
+      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 { is_expected.to eq(::Hashie::Mash.new({
-                                                  failed:         true,
+
+      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 { is_expected.to eq(::Hashie::Mash.new({
-                                                  failed:         false,
+
+      it {
+        expect(subject).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
+
+  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 'should call :get' do
-        stub_request(:get, 'https://api.pipedrive.com/v1/bases?api_token=token').to_return(:status => 200, :body => {}.to_json, :headers => {})
+      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 'should call :post' do
-        stub_request(:post, 'https://api.pipedrive.com/v1/bases?api_token=token').to_return(:status => 200, :body => {}.to_json, :headers => {})
+
+      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' }).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 => {}.to_json, :headers => {})
+
+      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' }).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 => {}.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)))
+
+      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 '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 => {}.to_json, :headers => {})
-        expect_any_instance_of(::Faraday::Connection).to receive(:get).
-          with('/v1/bases?api_token=token', {}).and_call_original
+
+      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 'should retry if Errno::ETIMEDOUT' do
-        stub_request(:get, 'https://api.pipedrive.com/v1/bases?api_token=token').to_return(:status => 200, :body => {}.to_json, :headers => {})
+
+      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
+        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 => {}.to_json, :headers => {})
+      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 'should call :post' do
-        stub_request(:post, 'https://api.pipedrive.com/v1/bases/13?api_token=token').to_return(:status => 200, :body => {}.to_json, :headers => {})
+
+      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' }).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 => {}.to_json, :headers => {})
+
+      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' }).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 => {})
+
+    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 '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 => {})
+
+    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

data/spec/lib/pipedrive/deal_field_spec.rb

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

data/spec/lib/pipedrive/deal_spec.rb

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

data/spec/lib/pipedrive/file_spec.rb

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