pipedrive_api_rb 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1736d092cf795cb084b83ba4bcf44308ad29dfa9d6ce87deb7f38236e5e565e5
+  data.tar.gz: 607e8e21ec8b1a674d4e0cdd3598099931535ce3a98b393f19302a0a166d71a3
+SHA512:
+  metadata.gz: cf8a9b1993e39a89716262aa3830f6ab73cf0b8cdf85199689e8309174c1c7735c0bd49c959112910967648a93c4683560a07927b8009784e8f5ec3449ac8945
+  data.tar.gz: 0ac483c074c8c6d483c678f910435492ddaf7b46bb37b12acd9877daa3305a1634a6be2a7388a784ad63427265cae4e574777656bd204de52f31f6af909f8759

data/.cane

@@ -0,0 +1,5 @@
+--no-doc
+--no-style
+--style-measure 99
+--abc-max 18
+--style-exclude spec/**/*

data/.gitignore

@@ -0,0 +1,23 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.idea

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,105 @@
+require:
+  - rubocop/cop/internal_affairs
+  - rubocop-performance
+  - rubocop-rspec
+AllCops:
+  NewCops: enable
+  Exclude:
+    - "bin/*"
+    - "vendor/**/*"
+    - "Rakefile"
+    - "tmp/**/*"
+    - ".git/**/*"
+  TargetRubyVersion: 2.5
+Style/Documentation:
+  Enabled: false
+Layout/LineLength:
+  Max: 1000
+Metrics/MethodLength:
+  Max: 250
+Metrics/ClassLength:
+  Max: 1000
+Metrics/AbcSize:
+  Max: 250
+Metrics/BlockLength:
+  Max: 1500
+Metrics/CyclomaticComplexity:
+  Max: 50
+Metrics/PerceivedComplexity:
+  Max: 50
+Style/ClassAndModuleChildren:
+  Enabled: false
+Style/ModuleFunction:
+  Enabled: false
+Style/ParallelAssignment:
+  Enabled: false
+Style/SymbolProc:
+  Enabled: false
+Layout/HashAlignment:
+  Enabled: false
+Metrics/BlockNesting:
+  Enabled: false
+Lint/NonLocalExitFromIterator:
+  Enabled: false
+Style/HashEachMethods:
+  Enabled: true
+Style/HashTransformKeys:
+  Enabled: true
+Style/HashTransformValues:
+  Enabled: true
+Style/AndOr:
+  Enabled: false
+RSpec/ExampleLength:
+  Enabled: false
+RSpec/MultipleExpectations:
+  Enabled: false
+RSpec/DescribeClass:
+  Enabled: false
+Style/IfInsideElse:
+  Enabled: false
+Layout/EmptyLinesAroundAttributeAccessor:
+  Enabled: true
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: true
+Lint/DeprecatedOpenSSLConstant:
+  Enabled: true
+Lint/MixedRegexpCaptureTypes:
+  Enabled: true
+Lint/RaiseException:
+  Enabled: true
+Lint/StructNewOverride:
+  Enabled: true
+Style/ExponentialNotation:
+  Enabled: false
+Style/RedundantFetchBlock:
+  Enabled: true
+Style/RedundantRegexpCharacterClass:
+  Enabled: true
+Style/RedundantRegexpEscape:
+  Enabled: true
+Style/SlicingWithRange:
+  Enabled: true
+Style/AccessorGrouping:
+  Enabled: true
+Style/BisectedAttrAccessor:
+  Enabled: true
+Style/RedundantAssignment:
+  Enabled: true
+Performance/AncestorsInclude:
+  Enabled: true
+Performance/BigDecimalWithNumericArgument:
+  Enabled: true
+Performance/RedundantSortBlock:
+  Enabled: true
+Performance/RedundantStringChars:
+  Enabled: true
+Performance/ReverseFirst:
+  Enabled: true
+Performance/SortReverse:
+  Enabled: true
+Performance/Squeeze:
+  Enabled: true
+Performance/StringInclude:
+  Enabled: true
+RSpec/ContextWording:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,14 @@
+language: ruby
+rvm:
+  - 2.7.2
+  - 3.1.2
+  - 3.2.0
+  - ruby-head
+
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+
+bundler_args: --without local_development
+
+before_install: gem install bundler

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in pipedrive.gemspec
+gemspec

data/HISTORY.md

@@ -0,0 +1,43 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [v0.3.0](https://github.com/amoniacou/pipedrive.rb/compare/v0.2.0...v0.3.0) - 2020-10-10
+
+### Merged
+
+- add User endpoints [`#15`](https://github.com/amoniacou/pipedrive.rb/pull/15)
+- add pipeline endpoints [`#17`](https://github.com/amoniacou/pipedrive.rb/pull/17)
+- add pipeline endpoints [`#2`](https://github.com/amoniacou/pipedrive.rb/pull/2)
+
+### Commits
+
+- Small code improvements [`fb28bb4`](https://github.com/amoniacou/pipedrive.rb/commit/fb28bb4ed3d86c15a4f2a95247e13393d598aad1)
+- Fix specs [`e772b83`](https://github.com/amoniacou/pipedrive.rb/commit/e772b837c61150b574ef3f6c95b495e1f2dfda9a)
+- Update .travis.yml [`873cea4`](https://github.com/amoniacou/pipedrive.rb/commit/873cea4cfd82806ef71f62a3db823322b168f964)
+
+## [v0.2.0](https://github.com/amoniacou/pipedrive.rb/compare/v0.1.0...v0.2.0) - 2020-01-14
+
+### Merged
+
+- Inflection fix for persons [`#9`](https://github.com/amoniacou/pipedrive.rb/pull/9)
+- Move adapter setup to the last line in defining connection [`#7`](https://github.com/amoniacou/pipedrive.rb/pull/7)
+- Replace find by find_by_id in the docs [`#5`](https://github.com/amoniacou/pipedrive.rb/pull/5)
+- Find by name organisation && update personfields [`#3`](https://github.com/amoniacou/pipedrive.rb/pull/3)
+
+### Commits
+
+- Remove problematic reek and cane [`bf8535c`](https://github.com/amoniacou/pipedrive.rb/commit/bf8535c10d0894fb508828a43aefb036b000c263)
+- Fix tests [`bca6171`](https://github.com/amoniacou/pipedrive.rb/commit/bca6171ae43068bd671bf6b8ecf924a7e2ad1af3)
+- Fix outdated rubocop, contrain on rake to pass reek [`e799cbc`](https://github.com/amoniacou/pipedrive.rb/commit/e799cbca4eada29582e6c5a1e20e8f97ed709713)
+
+## v0.1.0 - 2014-10-16
+
+### Commits
+
+- Initial commit [`cbd2138`](https://github.com/amoniacou/pipedrive.rb/commit/cbd2138ae11a19f4a398af3c25fac8ed2e6a0e1b)
+- Test coverage and small refactoring [`ca0577f`](https://github.com/amoniacou/pipedrive.rb/commit/ca0577fef23f59515cb58ea152e10d3130f26730)
+- Add more entities basic support. Add support for field selector [`73b47a4`](https://github.com/amoniacou/pipedrive.rb/commit/73b47a4455b1c50906bbc811bddac7d979fae966)

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Alexander Simonov
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,98 @@
+# Pipedrive Ruby API
+
+[![Build Status](https://app.travis-ci.com/honzasterba/pipedrive_rb.svg?branch=master)](https://app.travis-ci.com/honzasterba/pipedrive_rb)
+
+Pipedrive.com API wrapper
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'pipedrive_api_rb'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pipedrive_api_rb
+
+## Usage
+
+### Person
+
+You need initialize Person client:
+
+```ruby
+client = ::Pipedrive::Person.new('api_token')
+```
+
+You can get person's JSON data:
+
+```ruby
+person = client.find_by_id(12345)
+person.success? # check what request was successful
+person.data # JSON data of person entity
+```
+
+You can update person:
+
+```ruby
+res = client.update(12345, name: 'New Name', 'custom_field_key' => 'value')
+res.success? # check what request was successful
+res.data # updated JSON data of person
+```
+
+Or you can update person with only hash what include id:
+
+```ruby
+res = client.update(id: 12345, name: 'New Name', 'custom_field_key' => 'value')
+```
+
+You can get the list of all persons:
+
+```ruby
+all_persons = client.all # all persons - can be a time consume operation
+all_persons = client.all(start: 200) # Skipping first 200 persons
+```
+
+Or you can get first page of persons:
+
+```ruby
+first_page = client.chunk(start: 200, limit: 10) # get 10 records after skipping 200
+```
+
+Or you can iterate by all persons:
+
+```ruby
+client.each(start: 200) do |json_item|
+  # some logic
+end
+```
+
+Or you can work with enumerate:
+
+```ruby
+client.each(start: 100).select {|x| x['company_id'] == 12345}
+```
+
+### Rails integration
+
+If you need use only one pipedrive account for whole application, then you can create `config/initializer/pipedrive.rb` file with next content:
+
+```ruby
+Pipedrive.setup do |pd|
+  pd.api_token = ENV['PIPEDRIVE_API_TOKEN']
+end
+```
+
+And you can skip providing `api_token` to the entities classes.
+
+## Contributing
+
+1. Fork it ( https://github.com/honzasterba/pipedrive_api_rb/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,12 @@
+require 'bundler/gem_tasks'
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+# rubocop
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new(:rubocop)
+
+default_tasks = %i[spec rubocop]
+
+task default: default_tasks

data/defaults.reek

@@ -0,0 +1,11 @@
+---
+NestedIterators:
+  max_allowed_nesting: 2
+UtilityFunction:
+  enabled: false
+IrresponsibleModule:
+  enabled: false
+DuplicateMethodCall:
+  max_calls: 5
+FeatureEnvy:
+  enabled: false

data/lib/pipedrive/activity.rb

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

data/lib/pipedrive/activity_type.rb

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

data/lib/pipedrive/base.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+module Pipedrive
+  class Base
+    def initialize(api_token = ::Pipedrive.api_token)
+      raise 'api_token should be set' unless api_token.present?
+
+      @api_token = api_token
+    end
+
+    def connection
+      self.class.connection.dup
+    end
+
+    def make_api_call(*args)
+      params = args.extract_options!
+      method = args[0]
+      raise 'method param missing' unless method.present?
+
+      url = build_url(args, params.delete(:fields_to_select))
+      params = params.to_json unless method.to_sym == :get
+      begin
+        res = connection.__send__(method.to_sym, url, params)
+      rescue Errno::ETIMEDOUT
+        retry
+      rescue Faraday::ParsingError
+        sleep 5
+        retry
+      end
+      process_response(res)
+    end
+
+    def build_url(args, fields_to_select = nil)
+      url = +"/v1/#{entity_name}"
+      url << "/#{args[1]}" if args[1]
+      url << ":(#{fields_to_select.join(',')})" if fields_to_select.is_a?(::Array) && fields_to_select.size.positive?
+      url << "?api_token=#{@api_token}"
+      url
+    end
+
+    def process_response(res)
+      if res.success?
+        data = if res.body.is_a?(::Hashie::Mash)
+                 res.body.merge(success: true)
+               else
+                 ::Hashie::Mash.new(success: true)
+               end
+        return data
+      end
+      failed_response(res)
+    end
+
+    def failed_response(res)
+      failed_res = res.body.merge(success: false, not_authorized: false,
+                                  failed: false)
+      case res.status
+      when 401
+        failed_res[:not_authorized] = true
+      when 420
+        failed_res[:failed] = true
+      end
+      failed_res
+    end
+
+    def entity_name
+      class_name = self.class.name.split('::')[-1].downcase.pluralize
+      class_names = { 'people' => 'persons' }
+      class_names[class_name] || class_name
+    end
+
+    class << self
+      def faraday_options
+        { url:     'https://api.pipedrive.com',
+          headers: {
+            accept:       'application/json',
+            content_type: 'application/json',
+            user_agent:   ::Pipedrive.user_agent
+          } }
+      end
+
+      # This method smells of :reek:TooManyStatements
+      # :nodoc
+      def connection
+        @connection ||= Faraday.new(faraday_options) do |conn|
+          conn.request :url_encoded
+          conn.response :mashify
+          conn.response :json, content_type: /\bjson$/
+          conn.response :logger, ::Pipedrive.logger if ::Pipedrive.debug
+        end
+      end
+    end
+  end
+end

data/lib/pipedrive/deal.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+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,13 @@
+# frozen_string_literal: true
+
+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,10 @@
+# frozen_string_literal: true
+
+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,8 @@
+# frozen_string_literal: true
+
+module Pipedrive
+  class Filter < Base
+    include ::Pipedrive::Operations::Read
+    include ::Pipedrive::Operations::Delete
+  end
+end

data/lib/pipedrive/goal.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+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/lead.rb

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

data/lib/pipedrive/lead_label.rb

@@ -0,0 +1,12 @@
+module Pipedrive
+  class LeadLabel < Base
+    include ::Pipedrive::Operations::Create
+    include ::Pipedrive::Operations::Read
+    include ::Pipedrive::Operations::Update
+    include ::Pipedrive::Operations::Delete
+
+    def entity_name
+      'leadLabels'
+    end
+  end
+end

data/lib/pipedrive/note.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+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,13 @@
+# frozen_string_literal: true
+
+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,17 @@
+# frozen_string_literal: true
+
+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,32 @@
+# frozen_string_literal: true
+
+module Pipedrive
+  module Operations
+    module Read
+      extend ActiveSupport::Concern
+      include ::Enumerable
+      include ::Pipedrive::Utils
+
+      def each(params = {}, &block)
+        return to_enum(:each, params) unless block_given?
+
+        follow_pagination(:chunk, [], params, &block)
+      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,18 @@
+# frozen_string_literal: true
+
+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]
+        raise 'id must be provided' unless id
+
+        make_api_call(:put, id, params)
+      end
+    end
+  end
+end

data/lib/pipedrive/organization.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Pipedrive
+  class Organization < 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]
+      return to_enum(:find_by_name, params) unless block_given?
+
+      follow_pagination(:make_api_call, [:get, 'find'], params, &block)
+    end
+  end
+end