pipedrive-client 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 37486380ffaa9ba770ac49319bb0f2a52aa25b53
+  data.tar.gz: 44cebb818094f3903ad985329d8214902df5dd34
+SHA512:
+  metadata.gz: 47eceb5218da8d2ef256443f6fc71913eb441dd5277c6a81add1401c4db8a357b63feec6d40bb2c83da602072f72f3126085085e4d3bad8cba3f4b83885fa69d
+  data.tar.gz: dc8e96f561b2124093589d8f074c1ac6dfea208ac51ba531bb5a2fb3d69ceeda0305d51f8c08778832e9dc9f60fcc63bb15027751e93e5f3afe0a126a21373e0

data/.ruby-version

@@ -0,0 +1 @@
+2.1.1

data/Gemfile

@@ -0,0 +1,20 @@
+source "https://rubygems.org"
+ruby '2.1.1'
+
+gemspec
+
+gem 'rake'
+
+group :development do
+  gem 'pry'
+  # gem 'rspec'
+
+  # gem 'guard'
+  # gem 'guard-rspec', require: false
+  # gem 'guard-bundler'
+
+  # gem 'rb-fchange', :require=>false
+  # gem 'rb-fsevent', :require=>false
+  # gem 'rb-inotify', :require=>false
+  # gem 'terminal-notifier-guard'
+end

data/Gemfile.lock

@@ -0,0 +1,48 @@
+PATH
+  remote: .
+  specs:
+    pipedrive (0.0.2)
+      activesupport
+      faraday (>= 0.9.0)
+      faraday_middleware (>= 0.9.1)
+      multi_json
+      multi_xml
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (4.1.5)
+      i18n (~> 0.6, >= 0.6.9)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.1)
+      tzinfo (~> 1.1)
+    coderay (1.1.0)
+    faraday (0.9.0)
+      multipart-post (>= 1.2, < 3)
+    faraday_middleware (0.9.1)
+      faraday (>= 0.7.4, < 0.10)
+    i18n (0.6.11)
+    json (1.8.1)
+    method_source (0.8.2)
+    minitest (5.4.1)
+    multi_json (1.10.1)
+    multi_xml (0.5.5)
+    multipart-post (2.0.0)
+    pry (0.10.1)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rake (10.3.2)
+    slop (3.6.0)
+    thread_safe (0.3.4)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  pipedrive!
+  pry
+  rake

data/Rakefile

@@ -0,0 +1,14 @@
+require 'rubygems'
+require 'bundler/setup'
+
+task :console do
+  require 'pry'
+  require 'pipedrive'
+
+  CLIENT = Pipedrive::Client.new(api_token: '008f7b7f04e0737f1d3b2cbfc0ee0708461ca843')
+
+  ARGV.clear
+  Pry.start
+end
+
+task :default => :console

data/lib/pipedrive.rb

@@ -0,0 +1,30 @@
+require 'active_support'
+require 'active_support/core_ext/object'
+
+require 'faraday'
+require 'faraday_middleware'
+
+require 'pipedrive/version'
+require 'pipedrive/headers'
+require 'pipedrive/errors'
+require 'pipedrive/base'
+require 'pipedrive/client'
+require 'pipedrive/activities'
+require 'pipedrive/activity_types'
+require 'pipedrive/deals'
+require 'pipedrive/emails'
+require 'pipedrive/files'
+require 'pipedrive/filters'
+require 'pipedrive/goals'
+require 'pipedrive/notes'
+require 'pipedrive/organizations'
+require 'pipedrive/persons'
+require 'pipedrive/pipelines'
+require 'pipedrive/products'
+require 'pipedrive/roles'
+require 'pipedrive/stages'
+require 'pipedrive/users'
+
+module Pipedrive
+
+end

data/lib/pipedrive/activities.rb

@@ -0,0 +1,14 @@
+module Pipedrive
+  class Activities < Base
+    def prepare_options(options = {})
+      type_name = options.delete(:filter)
+      options[:params] = (options[:params]||{}).merge({type: type_name})
+
+      options
+    end
+
+    def types
+      resource(:activity_types).all
+    end
+  end
+end

data/lib/pipedrive/activity_types.rb

@@ -0,0 +1,3 @@
+module Pipedrive
+  class ActivityTypes < Base; end
+end

data/lib/pipedrive/base.rb

@@ -0,0 +1,145 @@
+module Pipedrive
+  class Base
+
+    include Enumerable
+
+    def initialize(options = {})
+      @options = options
+      authenticate
+    end
+
+    def authenticate(token = @options[:api_token])
+      default_params.merge! api_token: token
+    end
+
+    def get(options = @options)
+      return to_enum(__callee__, options) unless block_given?
+
+      response = _get_resource(options)
+      if response.success?
+        data = [(response.body['data'] || [])].flatten
+        data.each do |item|
+          yield OpenStruct.new item
+        end
+
+        if next_start(response)
+          options[:params] = (options[:params]||{}).merge({start: next_start(response)})
+          send(__callee__, options) do |data|
+            yield data
+          end
+        end
+      else
+        error_class = case response.status
+                      when 401 then AuthenticationError
+                      else
+                        ServiceError
+                      end
+        fail error_class, JSON.parse(response.body)['error']
+      end
+
+    end
+    alias_method :each, :get
+
+    def metrics
+      metrics = {total: all.count}
+
+      get.each do |item|
+        key = metric_key(item)
+        break if key.nil?
+
+        metrics[key] ||= 0
+        metrics[key] += 1
+      end
+
+      metrics
+    end
+
+    def metric_key(item)
+      (item.try(:type) || item.try(:status)).try(:to_sym)
+    end
+
+    def all(options = @options)
+      data = []
+      each(options).collect {|i| data << i}
+      data
+    end
+
+    def prepare_options(options = @options)
+      if options.has_key?(:sort_by)
+        key = options.delete(:sort_by)
+        dir = options.delete(:sort_mode) || :desc
+        options[:params] = (options[:params]||{}).merge({sort_by: key, sort_mode: dir})
+      end
+
+      options
+    end
+
+    def protocol
+      'http://'
+    end
+
+    def base_uri
+      protocol + 'api.pipedrive.com/v1'
+    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 = self.class.name.split('::').last
+      klass[0] = klass[0].chr.downcase
+      klass
+    end
+
+    def resource(klass_name, options = {})
+      klass_name = klass_name.to_s.split('_').map(&:capitalize).join
+      _klasses[klass_name] ||= begin
+        klass = Object.const_get "::Pipedrive::#{klass_name}"
+        klass.new @options.merge(options)
+      end
+    end
+
+    def [](id)
+      path = [resource_path, id.to_s].join '/'
+      get(resource_path: path).first
+    end
+
+    private
+      def _get_resource(options = {})
+
+        options = prepare_options(options)
+        params = default_params.merge (options.delete(:params) ||  {})
+
+
+        response = connection.get do |req|
+          req.url (options.delete(:resource_path) || resource_path)
+          req.headers = HEADERS
+          req.params.merge! params
+        end
+      end
+
+      def _klasses
+        @_klasses ||= {}
+      end
+
+      def next_start(response)
+        additional_data = response.body['additional_data']
+        if !additional_data.nil? && additional_data['pagination'] && additional_data['pagination']['more_items_in_collection']
+          additional_data['pagination']['next_start']
+        end
+      end
+
+      def default_params
+        @default_params ||= {}
+      end
+
+      def connection
+        @connection ||= ::Faraday.new(url: base_uri) do |conn|
+          conn.request :url_encoded
+          conn.adapter ::Faraday.default_adapter
+
+          conn.response :json, content_type: /\bjson$/
+          conn.response :xml,  content_type: /\bxml$/
+        end
+      end
+  end
+end

data/lib/pipedrive/client.rb

@@ -0,0 +1,41 @@
+module Pipedrive
+  class Client < Base
+    # This class doesn't represent anything on the API
+    # so we undefine the methods that could get us into
+    # trouble by attempting to talk to the server.
+
+    undef get
+    undef resource_path
+
+    def metrics
+      metrics = {}
+
+      %i{activities deals organizations persons}.each do |source|
+        metrics[source] = send(source).metrics
+      end
+
+      metrics
+    end
+
+    def validate_authorization
+      begin
+        users.metrics
+        true
+      rescue AuthenticationError
+        false
+      end
+    end
+
+    def method_missing(name, options, &block)
+      begin
+        resource(name, options)
+      rescue NameError
+        # Since we're silently loading a Resource Class
+        # we transform this into a NoMethodError to
+        # mask that. Not sure if this is the best idea ever,
+        # but I like it for now.
+        raise NoMethodError, "undefined method '#{name}' for #{self}"
+      end
+    end
+  end
+end

data/lib/pipedrive/deals.rb

@@ -0,0 +1,15 @@
+module Pipedrive
+  class Deals < Base
+    def prepare_options(options = {})
+      filter_name = options.delete(:filter)
+      if filter_name.present?
+        filter = resource(:filters)[filter_name]
+        if filter.present?
+          options[:params] = (options[:params]||{}).merge({filter_id: filter[:id]})
+        end
+      end
+
+      options
+    end
+  end
+end

data/lib/pipedrive/emails.rb

@@ -0,0 +1,7 @@
+module Pipedrive
+  class Emails < Base
+    def resource_path
+      "emailThreads"
+    end
+  end
+end

data/lib/pipedrive/errors.rb

@@ -0,0 +1,4 @@
+module Pipedrive
+  class AuthenticationError < StandardError; end
+  class ServiceError < StandardError; end
+end

data/lib/pipedrive/files.rb

@@ -0,0 +1,3 @@
+module Pipedrive
+  class Files < Base; end
+end

data/lib/pipedrive/filters.rb

@@ -0,0 +1,21 @@
+module Pipedrive
+  class Filters < Base
+    %w{deals people products organizations}.each do |type|
+      define_method type do |*options|
+        for_type(type, options.first)
+      end
+    end
+
+    def for_type(type, options = {})
+      type = type.to_sym
+      type = :org if type == :organizations
+
+      get (options || {}).merge!({params: {type: type}})
+    end
+
+    def [](name_key)
+      name = name_key.to_s.humanize
+      get.select{|filter| filter['name'] == name}.first
+    end
+  end
+end

data/lib/pipedrive/goals.rb

@@ -0,0 +1,3 @@
+module Pipedrive
+  class Goals < Base; end
+end

data/lib/pipedrive/headers.rb

@@ -0,0 +1,7 @@
+module Pipedrive
+  HEADERS = {
+    "User-Agent"    => "Ruby.Pipedrive.Api",
+    "Accept"        => "application/json",
+    "Content-Type"  => "application/x-www-form-urlencoded"
+  }
+end

data/lib/pipedrive/notes.rb

@@ -0,0 +1,3 @@
+module Pipedrive
+  class Notes < Base; end
+end

data/lib/pipedrive/organizations.rb

@@ -0,0 +1,3 @@
+module Pipedrive
+  class Organizations < Base; end
+end

data/lib/pipedrive/persons.rb

@@ -0,0 +1,3 @@
+module Pipedrive
+  class Persons < Base; end
+end

data/lib/pipedrive/pipelines.rb

@@ -0,0 +1,3 @@
+module Pipedrive
+  class Pipelines < Base; end
+end

data/lib/pipedrive/products.rb

@@ -0,0 +1,3 @@
+module Pipedrive
+  class Products < Base; end
+end

data/lib/pipedrive/roles.rb

@@ -0,0 +1,3 @@
+module Pipedrive
+  class Roles < Base; end
+end

data/lib/pipedrive/stages.rb

@@ -0,0 +1,3 @@
+module Pipedrive
+  class Stages < Base; end
+end

data/lib/pipedrive/users.rb

@@ -0,0 +1,3 @@
+module Pipedrive
+  class Users < Base; end
+end

data/lib/pipedrive/version.rb

@@ -0,0 +1,3 @@
+module Pipedrive
+  VERSION = "0.0.3"
+end

data/pipedrive.gemspec

@@ -0,0 +1,20 @@
+require './lib/pipedrive/version'
+
+Gem::Specification.new do |s|
+  s.name = 'pipedrive-client'
+  s.version = Pipedrive::VERSION
+  s.author = 'Ryan Faerman'
+  s.email = 'ryan@trepscore.com'
+  s.homepage = 'http://github.com/25-ventures/pipedrive'
+  s.summary = s.description = 'Interact with Pipedrive'
+
+  s.files = `git ls-files`.split("\n")
+  s.test_files = `git ls-files test`.split("\n")
+  s.require_path = 'lib'
+
+  s.add_dependency 'activesupport',       '~> 4.1'
+  s.add_dependency 'faraday',             '~> 0.9'
+  s.add_dependency 'faraday_middleware',  '~> 0.9'
+  s.add_dependency 'multi_xml',           '~>0.5'
+  s.add_dependency 'multi_json',          '~>1.10'
+end

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification
+name: pipedrive-client
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+platform: ruby
+authors:
+- Ryan Faerman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: multi_xml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+description: Interact with Pipedrive
+email: ryan@trepscore.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".ruby-version"
+- Gemfile
+- Gemfile.lock
+- Rakefile
+- lib/.DS_Store
+- lib/pipedrive.rb
+- lib/pipedrive/activities.rb
+- lib/pipedrive/activity_types.rb
+- lib/pipedrive/base.rb
+- lib/pipedrive/client.rb
+- lib/pipedrive/deals.rb
+- lib/pipedrive/emails.rb
+- lib/pipedrive/errors.rb
+- lib/pipedrive/files.rb
+- lib/pipedrive/filters.rb
+- lib/pipedrive/goals.rb
+- lib/pipedrive/headers.rb
+- lib/pipedrive/notes.rb
+- lib/pipedrive/organizations.rb
+- lib/pipedrive/persons.rb
+- lib/pipedrive/pipelines.rb
+- lib/pipedrive/products.rb
+- lib/pipedrive/roles.rb
+- lib/pipedrive/stages.rb
+- lib/pipedrive/users.rb
+- lib/pipedrive/version.rb
+- pipedrive.gemspec
+homepage: http://github.com/25-ventures/pipedrive
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Interact with Pipedrive
+test_files: []