pipedrive_api_rb 1.0.0

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

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe ::Pipedrive::Operations::Read do
+  subject do
+    Class.new(::Pipedrive::Base) do
+      include ::Pipedrive::Operations::Read
+    end.new('token')
+  end
+
+  describe '#find_by_id' do
+    it 'calls #make_api_call' do
+      expect(subject).to receive(:make_api_call).with(:get, 12)
+      subject.find_by_id(12)
+    end
+  end
+
+  describe '#each' do
+    let(:additional_data) do
+      { pagination: { more_items_in_collection?: true, next_start: 10 } }
+    end
+
+    it 'returns Enumerator if no block given' do
+      expect(subject.each).to be_a(::Enumerator)
+    end
+
+    it 'calls to_enum with params' do
+      expect(subject).to receive(:to_enum).with(:each, { foo: 'bar' })
+      subject.each(foo: 'bar')
+    end
+
+    it 'yields data' do
+      expect(subject).to receive(:chunk).and_return(::Hashie::Mash.new(data: [1, 2], success: true))
+      expect { |b| subject.each(&b) }.to yield_successive_args(1, 2)
+    end
+
+    it 'follows pagination' do
+      expect(subject).to receive(:chunk).with(start: 0).and_return(::Hashie::Mash.new(data: [1, 2], success: true, additional_data: additional_data))
+      expect(subject).to receive(:chunk).with(start: 10).and_return(::Hashie::Mash.new(data: [3, 4], success: true))
+      expect { |b| subject.each(&b) }.to yield_successive_args(1, 2, 3, 4)
+    end
+
+    it 'does not yield anything if result is empty' do
+      expect(subject).to receive(:chunk).with(start: 0).and_return(::Hashie::Mash.new(success: true))
+      expect { |b| subject.each(&b) }.to yield_successive_args
+    end
+
+    it 'does not yield anything if result is not success' do
+      expect(subject).to receive(:chunk).with(start: 0).and_return(::Hashie::Mash.new(success: false))
+      expect { |b| subject.each(&b) }.to yield_successive_args
+    end
+  end
+
+  describe '#all' do
+    it 'calls #each' do
+      arr = double('enumerator')
+      allow(arr).to receive(:to_a)
+      expect(subject).to receive(:each).and_return(arr)
+      subject.all
+    end
+  end
+
+  describe '#chunk' do
+    it 'returns []' do
+      res = double('res', success?: false)
+      expect(subject).to receive(:make_api_call).with(:get, {}).and_return(res)
+      expect(subject.chunk).to eq([])
+    end
+
+    it 'returns result' do
+      res = double('res', success?: true)
+      expect(subject).to receive(:make_api_call).with(:get, {}).and_return(res)
+      expect(subject.chunk).to eq(res)
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe ::Pipedrive::Operations::Update do
+  subject do
+    Class.new(::Pipedrive::Base) do
+      include ::Pipedrive::Operations::Update
+    end.new('token')
+  end
+
+  describe '#create' do
+    it 'calls #make_api_call' do
+      expect(subject).to receive(:make_api_call).with(:put, 12, { foo: 'bar' })
+      subject.update(12, foo: 'bar')
+    end
+
+    it 'calls #make_api_call with id in params' do
+      expect(subject).to receive(:make_api_call).with(:put, 14, { foo: 'bar' })
+      subject.update(foo: 'bar', id: 14)
+    end
+  end
+end

data/spec/lib/pipedrive/organization_field_spec.rb

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

data/spec/lib/pipedrive/person_field_spec.rb

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

data/spec/lib/pipedrive/person_spec.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe ::Pipedrive::Person do
+  subject { described_class.new('token') }
+
+  describe '#entity_name' do
+    subject { super().entity_name }
+
+    it { is_expected.to eq('persons') }
+  end
+
+  describe '#find_by_name' do
+    it 'calls #make_api_call with term' do
+      expect(subject).to receive(:make_api_call).with(:get, 'find', { term: 'term', search_by_email: 0, start: 0 })
+      expect { |b| subject.find_by_name('term', &b) }.to yield_successive_args
+    end
+
+    it 'calls #make_api_call with term and search_by_email' do
+      expect(subject).to receive(:make_api_call).with(:get, 'find', { term: 'term', search_by_email: 1, start: 0 })
+      expect { |b| subject.find_by_name('term', true, &b) }.to yield_successive_args
+    end
+
+    it 'yields results' do
+      expect(subject).to receive(:make_api_call).with(:get, 'find', { term: 'term', search_by_email: 0, start: 0 }).and_return(::Hashie::Mash.new(data: [1, 2], success: true))
+      expect { |b| subject.find_by_name('term', &b) }.to yield_successive_args(1, 2)
+    end
+  end
+end

data/spec/lib/pipedrive/product_field_spec.rb

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

data/spec/lib/pipedrive/product_spec.rb

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

data/spec/lib/pipedrive_spec.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe ::Pipedrive do
+  subject { described_class }
+
+  before do
+    described_class.reset!
+  end
+
+  describe '#reset!' do
+    describe '#user_agent' do
+      subject { super().user_agent }
+
+      it { is_expected.to eq("Pipedrive Ruby Client v#{::Pipedrive::VERSION}") }
+    end
+
+    describe '#api_token' do
+      subject { super().api_token }
+
+      it { is_expected.to be_nil }
+    end
+
+    describe '#logger' do
+      subject { super().logger }
+
+      it { is_expected.to be_kind_of(::Logger) }
+    end
+  end
+
+  describe '#setup' do
+    context 'single call' do
+      let(:client) { described_class }
+
+      it 'sets user_agent' do
+        client.setup do |c|
+          c.user_agent = 'Test1245'
+        end
+        expect(client.user_agent).to eq('Test1245')
+      end
+
+      it 'sets logger' do
+        newlogger = ::Logger.new($stderr)
+        client.setup do |c|
+          c.logger = newlogger
+        end
+        expect(client.logger).to eq(newlogger)
+      end
+
+      it 'sets api_token' do
+        client.setup do |c|
+          c.api_token = 'test-api-key'
+        end
+        expect(client.api_token).to eq('test-api-key')
+      end
+    end
+
+    context 'with double call' do
+      let(:client) { described_class }
+
+      it 'does not accept running setup more then once' do
+        client.setup do |c|
+          c.api_token = 'test-api-key'
+        end
+        client.setup do |c|
+          c.api_token = 'test-api-key2'
+        end
+        expect(client.api_token).to eq('test-api-key')
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require 'webmock'
+require 'webmock/rspec'
+require 'pipedrive'

metadata

@@ -0,0 +1,285 @@
+--- !ruby/object:Gem::Specification
+name: pipedrive_api_rb
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jan Sterba
+- Alexander Simonov
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-01-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: faraday
+  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-mashify
+  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: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '12'
+- !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'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  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'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  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: Pipedrive.com API Wrapper
+email:
+- info@jansterba.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".cane"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- HISTORY.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- defaults.reek
+- lib/pipedrive.rb
+- lib/pipedrive/activity.rb
+- lib/pipedrive/activity_type.rb
+- lib/pipedrive/base.rb
+- lib/pipedrive/deal.rb
+- lib/pipedrive/deal_field.rb
+- lib/pipedrive/file.rb
+- lib/pipedrive/filter.rb
+- lib/pipedrive/goal.rb
+- lib/pipedrive/lead.rb
+- lib/pipedrive/lead_label.rb
+- lib/pipedrive/note.rb
+- lib/pipedrive/operations/create.rb
+- lib/pipedrive/operations/delete.rb
+- lib/pipedrive/operations/read.rb
+- lib/pipedrive/operations/update.rb
+- lib/pipedrive/organization.rb
+- lib/pipedrive/organization_field.rb
+- lib/pipedrive/person.rb
+- lib/pipedrive/person_field.rb
+- lib/pipedrive/pipeline.rb
+- lib/pipedrive/product.rb
+- lib/pipedrive/product_field.rb
+- lib/pipedrive/railties.rb
+- lib/pipedrive/role.rb
+- lib/pipedrive/stage.rb
+- lib/pipedrive/user.rb
+- lib/pipedrive/utils.rb
+- lib/pipedrive/version.rb
+- pipedrive.gemspec
+- spec/lib/pipedrive/activity_spec.rb
+- spec/lib/pipedrive/activity_type_spec.rb
+- spec/lib/pipedrive/base_spec.rb
+- spec/lib/pipedrive/deal_field_spec.rb
+- spec/lib/pipedrive/deal_spec.rb
+- spec/lib/pipedrive/file_spec.rb
+- spec/lib/pipedrive/filter_spec.rb
+- spec/lib/pipedrive/goal_spec.rb
+- spec/lib/pipedrive/lead_label_spec.rb
+- spec/lib/pipedrive/lead_spec.rb
+- spec/lib/pipedrive/note_spec.rb
+- spec/lib/pipedrive/ogranization_spec.rb
+- spec/lib/pipedrive/operations/create_spec.rb
+- spec/lib/pipedrive/operations/delete_spec.rb
+- spec/lib/pipedrive/operations/read_spec.rb
+- spec/lib/pipedrive/operations/update_spec.rb
+- spec/lib/pipedrive/organization_field_spec.rb
+- spec/lib/pipedrive/person_field_spec.rb
+- spec/lib/pipedrive/person_spec.rb
+- spec/lib/pipedrive/product_field_spec.rb
+- spec/lib/pipedrive/product_spec.rb
+- spec/lib/pipedrive_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/honzasterba/pipedrive_api_rb
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.5'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: Pipedrive.com API Wrapper
+test_files:
+- spec/lib/pipedrive/activity_spec.rb
+- spec/lib/pipedrive/activity_type_spec.rb
+- spec/lib/pipedrive/base_spec.rb
+- spec/lib/pipedrive/deal_field_spec.rb
+- spec/lib/pipedrive/deal_spec.rb
+- spec/lib/pipedrive/file_spec.rb
+- spec/lib/pipedrive/filter_spec.rb
+- spec/lib/pipedrive/goal_spec.rb
+- spec/lib/pipedrive/lead_label_spec.rb
+- spec/lib/pipedrive/lead_spec.rb
+- spec/lib/pipedrive/note_spec.rb
+- spec/lib/pipedrive/ogranization_spec.rb
+- spec/lib/pipedrive/operations/create_spec.rb
+- spec/lib/pipedrive/operations/delete_spec.rb
+- spec/lib/pipedrive/operations/read_spec.rb
+- spec/lib/pipedrive/operations/update_spec.rb
+- spec/lib/pipedrive/organization_field_spec.rb
+- spec/lib/pipedrive/person_field_spec.rb
+- spec/lib/pipedrive/person_spec.rb
+- spec/lib/pipedrive/product_field_spec.rb
+- spec/lib/pipedrive/product_spec.rb
+- spec/lib/pipedrive_spec.rb
+- spec/spec_helper.rb