pipedrive.rb 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 11021dff174077aefb3589a979112cedc1677918
+  data.tar.gz: 76c18fb73b4f56968d580352c6b7590959570bdc
+SHA512:
+  metadata.gz: 96a28445400ffc9cb4a59da4ed0a300c7a2aab5df6a81081dcfeca4b4d2daf0446372fa5608b0f631ee4feff20412c5ac8c8bc9488df29ed9a04714e7ab91056
+  data.tar.gz: fcffc1f3a0b89de8a9b5a7b99c180964645007fef72972e57dbf20e1d3ad8cda0002684acc1b993f809d4b458ab996c23416520e2b8b4ae1faedb735949421df

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,17 @@
+AllCops:
+  Include:
+    - '**/Rakefile'
+  Exclude:
+    - 'spec/**/*'
+Style/LineLength:
+  Max: 99
+Style/FileName:
+  Enabled: false
+Style/ModuleFunction:
+  Enabled: false
+Style/Encoding:
+  Enabled: false
+Documentation:
+  Enabled: false
+Style/MethodLength:
+  Max: 15

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 2.1
+  - ruby-head
+  - jruby-19mode
+  - rbx-2
+matrix:
+  allow_failures:
+    - rvm: ruby-head

data/Gemfile

@@ -0,0 +1,20 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in pipedrive.gemspec
+gemspec
+
+group :test do
+  gem 'simplecov', '>= 0.9.0', :require => false
+  gem 'coveralls', :require => false
+end
+
+group :local_development do
+  gem 'terminal-notifier-guard', require: false if RUBY_PLATFORM.downcase.include?('darwin')
+  gem 'guard-rspec', '>= 4.3.1' ,require: false
+  gem 'guard-bundler', require: false
+  gem 'guard-preek', require: false
+  gem 'guard-rubocop', require: false
+  gem 'guard-cane', require: false
+  gem 'guard-reek', github: 'pericles/guard-reek', require: false
+  gem 'pry'
+end

data/Guardfile

@@ -0,0 +1,24 @@
+guard 'rspec', cmd: 'rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+
+guard 'bundler' do
+  watch('Gemfile')
+  watch('pipedrive.gemspec')
+end
+
+guard :cane do
+  watch(%r{^(.+)\.rb$})
+end
+
+guard :rubocop do
+  watch(%r{.+\.rb$})
+  watch(%r{(?:.+/)?\.rubocop\.yml$}) { |m| File.dirname(m[0]) }
+end
+
+guard :preek, run_all_dir: 'lib' do
+	watch(/^lib\/(.*).rb/)
+end
+

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,100 @@
+# Pipedrive
+
+[![Build Status](https://travis-ci.org/dotpromo/pipedrive.rb.svg?branch=master)](https://travis-ci.org/dotpromo/pipedrive.rb)
+[![Code Climate](https://codeclimate.com/github/dotpromo/pipedrive.rb.png)](https://codeclimate.com/github/dotpromo/pipedrive.rb)
+[![Coverage Status](https://img.shields.io/coveralls/dotpromo/pipedrive.rb.svg)](https://coveralls.io/r/dotpromo/pipedrive.rb)
+
+Pipedrive.com API wrapper
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'pipedrive.rb'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pipedrive.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(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 |n|
+  n.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/simonoff/pipedrive/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,27 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+# rubocop
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new(:rubocop)
+
+# reek
+require 'reek/rake/task'
+
+Reek::Rake::Task.new do |t|
+  t.fail_on_error = false
+  t.source_files = Dir['lib/**/*.rb']
+end
+
+default_tasks = [:spec, :rubocop, :reek]
+
+unless defined? ::Rubinius
+  # cane
+  require 'cane/rake_task'
+  Cane::RakeTask.new
+  default_tasks << :cane
+end
+
+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.rb

@@ -0,0 +1,92 @@
+require 'logger'
+require 'active_support/core_ext/hash'
+require 'active_support/concern'
+require 'active_support/inflector'
+
+ActiveSupport::Inflector.inflections do |inflect|
+  inflect.irregular 'person', 'persons'
+end
+
+require 'hashie'
+require 'faraday'
+require 'faraday_middleware'
+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'
+
+# Files
+require 'pipedrive/file'
+
+# Notes
+require 'pipedrive/note'

data/lib/pipedrive/activity.rb

@@ -0,0 +1,8 @@
+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,12 @@
+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,87 @@
+module Pipedrive
+  class Base
+    def initialize(api_token = ::Pipedrive.api_token)
+      fail '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]
+      fail 'method param missing' unless method.present?
+      url = build_url(args, params.delete(:fields_to_select))
+      begin
+        res = connection.__send__(method.to_sym, url, params)
+      rescue Errno::ETIMEDOUT
+        retry
+      end
+      process_response(res)
+    end
+
+    def build_url(args, fields_to_select = nil)
+      url = "/v1/#{entity_name}"
+      url << "/#{args[1]}" if args[1]
+      if fields_to_select.is_a?(::Array) && fields_to_select.size > 0
+        url << ":(#{fields_to_select.join(',')})"
+      end
+      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.merge! not_authorized: true
+      when 420
+        failed_res.merge! failed: true
+      end
+      failed_res
+    end
+
+    def entity_name
+      self.class.name.split('::')[-1].downcase.pluralize
+    end
+
+    class << self
+      def faraday_options
+        {
+          url:     'https://api.pipedrive.com',
+          headers: {
+            accept:     'application/json',
+            user_agent: ::Pipedrive.user_agent
+          }
+        }
+      end
+
+      # This method smells of :reek:TooManyStatements
+      def connection # :nodoc
+        @connection ||= Faraday.new(faraday_options) do |conn|
+          conn.request :url_encoded
+          conn.response :mashify
+          conn.response :json, content_type: /\bjson$/
+          conn.adapter Faraday.default_adapter
+          conn.use FaradayMiddleware::ParseJson
+          conn.response :logger, ::Pipedrive.logger if ::Pipedrive.debug
+        end
+      end
+    end
+  end
+end