pipedrive-api-client 0.3.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a03f3fca313457dfd86f8824ebd9d5f53a6c5631
+  data.tar.gz: e4b3a357a77d37f6c75a1418bab512513dbfd999
+SHA512:
+  metadata.gz: 8a628b0c344994b9c546bb851a6e2fdb78694e491d1c0cd9cf61088f22d433e29a90af00f687d1abe5bcd5e241868929e5826d4268f7ebbe6c75e8f80b05f381
+  data.tar.gz: 4afe74d5f8f9202adf10a3d4b3fdfbfff2ee1bc031f6ac83a0a9c780a90747d12bd5a6564c183203cdbdcbbd1dea39a255f6b009574114e737068ba7a8843739

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,20 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+gem 'httparty'
+gem 'json', '>= 1.7.7'
+gem 'multi_xml', '>= 0.5.2'
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda", ">= 0"
+  gem "rdoc", "~> 3.12"
+  gem "bundler", ">= 1.0.0"
+  gem "jeweler", ">= 1.8.4"
+  gem "simplecov", ">= 0"
+  gem 'webmock'
+  gem 'coveralls', :require => false
+end

data/Gemfile.lock

@@ -0,0 +1,71 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (3.2.12)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    addressable (2.3.4)
+    bourne (1.1.2)
+      mocha (= 0.10.5)
+    colorize (0.5.8)
+    coveralls (0.6.7)
+      colorize
+      multi_json (~> 1.3)
+      rest-client
+      simplecov (>= 0.7)
+      thor
+    crack (0.4.0)
+      safe_yaml (~> 0.9.0)
+    git (1.2.5)
+    httparty (0.10.2)
+      multi_json (~> 1.0)
+      multi_xml (>= 0.5.2)
+    i18n (0.6.4)
+    jeweler (1.8.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.7.7)
+    metaclass (0.0.1)
+    mime-types (1.24)
+    mocha (0.10.5)
+      metaclass (~> 0.0.1)
+    multi_json (1.6.1)
+    multi_xml (0.5.3)
+    rake (10.0.3)
+    rdoc (3.12.2)
+      json (~> 1.4)
+    rest-client (1.6.7)
+      mime-types (>= 1.16)
+    safe_yaml (0.9.3)
+    shoulda (3.3.2)
+      shoulda-context (~> 1.0.1)
+      shoulda-matchers (~> 1.4.1)
+    shoulda-context (1.0.2)
+    shoulda-matchers (1.4.2)
+      activesupport (>= 3.0.0)
+      bourne (~> 1.1.2)
+    simplecov (0.7.1)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.7.1)
+    simplecov-html (0.7.1)
+    thor (0.18.1)
+    webmock (1.11.0)
+      addressable (>= 2.2.7)
+      crack (>= 0.3.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (>= 1.0.0)
+  coveralls
+  httparty
+  jeweler (>= 1.8.4)
+  json (>= 1.7.7)
+  multi_xml (>= 0.5.2)
+  rdoc (~> 3.12)
+  shoulda
+  simplecov
+  webmock

data/README.md

@@ -0,0 +1,44 @@
+# pipedrive-api-client
+
+## Credits
+
+This gem is based on pipedrive-ruby by @GeneralScripting. Since that gem doesn't seem active anymore and the PR's don't get merged I created this one and implemented some of the PR's needed to use the Pipedrive API. 
+
+## Installation
+
+    gem install pipedrive-api-client
+
+## Usage
+
+    require 'pipedrive-api-client'
+    Pipedrive.authenticate( YOUR_API_TOKEN )
+    Pipedrive::Deal.find( DEAL_ID )
+
+## API Calls
+    Pipedrive::Deal.create( params )
+    Pipedrive::Deal.find( <ID> )
+
+    Pipedrive::Organization.create( params )
+    Pipedrive::Organization.find( <ID> )
+
+    Pipedrive::Person.create( params )
+    Pipedrive::Person.find( <ID >)
+
+    Pipedrive::Note.create( params )
+
+You can check some of the calls at https://developers.pipedrive.com/v1
+
+
+## Contributing to pipedrive-api-client
+
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+## License
+
+This gem is released under the [MIT License](http://www.opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,45 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "pipedrive-api-client"
+  gem.homepage = "https://github.com/boena/pipedrive-api-client.git"
+  gem.license = "MIT"
+  gem.summary = %Q{Ruby wrapper for the Pipedrive API}
+  gem.description = %Q{Ruby wrapper for the Pipedrive API}
+  gem.email = "bjorn@ratherunique.se"
+  gem.authors = ["Björn Lennartsson", "Jan Schwenzien", "Waldemar Kusnezow", "Joel Courtney"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "pipedrive-api-client #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.3.4

data/lib/pipedrive-api-client.rb

@@ -0,0 +1,34 @@
+require 'pipedrive/base'
+require 'pipedrive/activity'
+require 'pipedrive/activity-type'
+require 'pipedrive/authorization'
+require 'pipedrive/currency'
+require 'pipedrive/deal'
+require 'pipedrive/deal-field'
+require 'pipedrive/file'
+require 'pipedrive/filter'
+require 'pipedrive/note'
+require 'pipedrive/organization'
+require 'pipedrive/person'
+require 'pipedrive/organization-field'
+require 'pipedrive/person-field'
+require 'pipedrive/permission-set'
+require 'pipedrive/pipeline'
+require 'pipedrive/product'
+require 'pipedrive/product-field'
+require 'pipedrive/role'
+require 'pipedrive/search-result'
+require 'pipedrive/stage'
+require 'pipedrive/user'
+require 'pipedrive/user-setting'
+require 'pipedrive/goal'
+require 'pipedrive/user-connection'
+require 'pipedrive/push-notification'
+
+module Pipedrive
+
+  def self.authenticate(token)
+    Base.authenticate(token)
+  end
+
+end

data/lib/pipedrive/activity-type.rb

@@ -0,0 +1,4 @@
+module Pipedrive
+  class ActivityType < Base
+  end
+end

data/lib/pipedrive/activity.rb

@@ -0,0 +1,4 @@
+module Pipedrive
+  class Activity < Base
+  end
+end

data/lib/pipedrive/authorization.rb

@@ -0,0 +1,4 @@
+module Pipedrive
+  class Authorization < Base
+  end
+end

data/lib/pipedrive/base.rb

@@ -0,0 +1,134 @@
+require 'httparty'
+require 'ostruct'
+require 'forwardable'
+
+module Pipedrive
+
+  # Globally set request headers
+  HEADERS = {
+    "User-Agent"    => "Ruby.Pipedrive.Api",
+    "Accept"        => "application/json",
+    "Content-Type"  => "application/x-www-form-urlencoded"
+  }
+
+  # Base class for setting HTTParty configurations globally
+  class Base < OpenStruct
+
+    include HTTParty
+
+    base_uri 'https://api.pipedrive.com/v1'
+    headers HEADERS
+    format :json
+
+    extend Forwardable
+    def_delegators 'self.class', :delete, :get, :post, :put, :resource_path, :bad_response
+
+    attr_reader :data
+
+    # Create a new Pipedrive::Base object.
+    #
+    # Only used internally
+    #
+    # @param [Hash] attributes
+    # @return [Pipedrive::Base]
+    def initialize(attrs = {})
+      if attrs['data']
+        struct_attrs = attrs['data']
+
+        if attrs['additional_data']
+          struct_attrs.merge!(attrs['additional_data'])
+        end
+      else
+        struct_attrs = attrs
+      end
+
+      super(struct_attrs)
+    end
+
+    # Updates the object.
+    #
+    # @param [Hash] opts
+    # @return [Boolean]
+    def update(opts = {})
+      res = put "#{resource_path}/#{id}", :body => opts
+      if res.success?
+        res['data'] = Hash[res['data'].map {|k, v| [k.to_sym, v] }]
+        @table.merge!(res['data'])
+      else
+        false
+      end
+    end
+
+    class << self
+      # Sets the authentication credentials in a class variable.
+      #
+      # @param [String] email cl.ly email
+      # @param [String] password cl.ly password
+      # @return [Hash] authentication credentials
+      def authenticate(token)
+        default_params :api_token => token
+      end
+
+      # Examines a bad response and raises an appropriate exception
+      #
+      # @param [HTTParty::Response] response
+      def bad_response(response, params={})
+        if response.class == HTTParty::Response
+          raise HTTParty::ResponseError, response
+        end
+        raise StandardError, 'Unknown error'
+      end
+
+      def new_list( attrs )
+        attrs['data'].is_a?(Array) ? attrs['data'].map {|data| self.new( 'data' => data ) } : []
+      end
+
+      def all(response = nil, options = {}, get_absolutely_all = false)
+        res = response || get(resource_path, options)
+        if res.ok?
+          data = res['data'].nil? ? [] : res['data'].map{|obj| new(obj)}
+          if get_absolutely_all && has_pagination?(res)
+            options[:query] = options[:query].merge({:start => res['additional_data']['pagination']['next_start']})
+            data += self.all(nil,options,true)
+          end
+          data
+        else
+          bad_response(res, options)
+        end
+      end
+
+      def has_pagination?(res)
+        res['additional_data'] && res['additional_data']['pagination'] && res['additional_data']['pagination']['more_items_in_collection']
+      end
+
+      def create( opts = {} )
+        res = post resource_path, :body => opts
+        if res.success?
+          res['data'] = opts.merge res['data']
+          new(res)
+        else
+          bad_response(res,opts)
+        end
+      end
+
+      def find(id)
+        res = get "#{resource_path}/#{id}"
+        res.ok? ? new(res) : bad_response(res,id)
+      end
+
+      def find_by_name(name, opts={})
+        res = get "#{resource_path}/find", :query => { :term => name }.merge(opts)
+        res.ok? ? new_list(res) : bad_response(res,{:name => name}.merge(opts))
+      end
+
+      def resource_path
+        # The resource path should match the camelCased class name with the
+        # first letter downcased.  Pipedrive API is sensitive to capitalisation
+        klass = name.split('::').last
+        klass[0] = klass[0].chr.downcase
+        klass.end_with?('y') ? "/#{klass.chop}ies" : "/#{klass}s"
+      end
+    end
+  end
+
+end

data/lib/pipedrive/currency.rb

@@ -0,0 +1,4 @@
+module Pipedrive
+  class Currency < Base
+  end
+end

data/lib/pipedrive/deal-field.rb

@@ -0,0 +1,4 @@
+module Pipedrive
+  class DealField < Base
+  end
+end

data/lib/pipedrive/deal.rb

@@ -0,0 +1,31 @@
+module Pipedrive
+  class Deal < Base
+
+    def add_product(opts = {})
+      res = post "#{resource_path}/#{id}/products", :body => opts
+      res.success? ? res['data']['product_attachment_id'] : bad_response(res,opts)
+    end
+
+    def products
+      Product.all(get "#{resource_path}/#{id}/products")
+    end
+    
+    def remove_product product_attachment_id
+      res = delete "#{resource_path}/#{id}/products", { :body => { :product_attachment_id => product_attachment_id } }
+      res.success? ? nil : bad_response(res,product_attachment_id)
+    end
+
+    def activities
+      Activity.all(get "#{resource_path}/#{id}/activities")
+    end
+
+    def files
+      File.all(get "#{resource_path}/#{id}/files")
+    end
+
+    def notes(opts = {:sort_by => 'add_time', :sort_mode => 'desc'})
+      Note.all( get("/notes", :query => opts.merge(:deal_id => id) ) )
+    end
+    
+  end
+end

data/lib/pipedrive/file.rb

@@ -0,0 +1,4 @@
+module Pipedrive
+  class File < Base
+  end
+end

data/lib/pipedrive/filter.rb

@@ -0,0 +1,4 @@
+module Pipedrive
+  class Filter < Base
+  end
+end