paperdrive 0.0.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9e70d62d8272e1fb31e8f490c696daf0aee9e6b24fdd2166dc89a50d377027cf
+  data.tar.gz: 027bd41cf1cd3ecbda7fa80bc0b377c175f95e6800fb61937ed0bda8dded5b0e
+SHA512:
+  metadata.gz: 6aff1139b7d433fc1fcb52350e8ca1ba3eab0f90b1886ea468d991179d0a627de3c8d94bd7a331487d42d28f2ea1f68c88766b07cdd6b9f22ae20a71c1d28e17
+  data.tar.gz: 83e4f629d87bbb641d30e69a9c98a7e9b2a4d8a1d3a829257c30318ba63c2f95ee4916a6827f021be2f010cffb94272c0790a6e785ef99dddcd027acbde345d1

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/vendor/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,18 @@
+AllCops:
+  DisplayCopNames: true
+  TargetRubyVersion: 2.3
+LineLength:
+  Enabled: false
+Layout/EmptyLineAfterMagicComment:
+  StyleGuide: '#separate-magic-comments-from-code'
+  Enabled: true
+Metrics/AbcSize:
+  Enabled: false
+Style/StructInheritance:
+  Enabled: false
+Style/Documentation:
+  Enabled: false
+Style/RedundantFreeze:
+  Enabled: true
+Metrics:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,9 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.6.0
+  - 2.5.0
+  - 2.4.3
+  - 2.3.4
+before_install: gem install bundler
+script: bundle exec rake spec

data/CHANGELOG.md

@@ -0,0 +1,29 @@
+# Change Log
+All notable changes to this project will be documented in this file.
+
+The format is maybe based on [Keep a Changelog](http://keepachangelog.com/)
+
+## [0.0.5] - 2019-01-26
+### Changed
+- changed the gem name from 'Paperdrive' to 'paperdrive'.
+
+## [0.0.4] - 2019-01-16
+### Added
+- add many PaperDrive::Client::XXXXs
+
+## [0.0.3] - 2019-01-15
+### Added
+- add many PaperDrive::Client::XXXXs
+
+## [0.0.2] - 2019-01-15
+### Added
+- CHANGELOG.md
+- PaperDrive::Client::Activities
+- PaperDrive::Client::Notes
+
+### Changed
+- Drastically changed the architecture
+
+## 0.0.1 - 2019-01-08 [yanked]
+### Added
+- Released!

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in paperdrive.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,75 @@
+PATH
+  remote: .
+  specs:
+    Paperdrive (0.0.4)
+      activesupport
+      faraday (~> 0.15.4)
+      faraday_middleware (~> 0.12.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (5.2.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    ast (2.4.0)
+    concurrent-ruby (1.1.4)
+    diff-lcs (1.3)
+    faraday (0.15.4)
+      multipart-post (>= 1.2, < 3)
+    faraday_middleware (0.12.2)
+      faraday (>= 0.7.4, < 1.0)
+    i18n (1.5.2)
+      concurrent-ruby (~> 1.0)
+    jaro_winkler (1.5.2)
+    minitest (5.11.3)
+    multipart-post (2.0.0)
+    parallel (1.12.1)
+    parser (2.5.3.0)
+      ast (~> 2.4.0)
+    powerpack (0.1.2)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    rubocop (0.62.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.4.0)
+    ruby-progressbar (1.10.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.4.1)
+    yard (0.9.16)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  Paperdrive!
+  bundler (~> 1.16)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rubocop (~> 0.62.0)
+  yard
+
+BUNDLED WITH
+   1.16.1

data/README.md

@@ -0,0 +1,120 @@
+# Paperdrive
+
+Paperdrive is the unofficial [Pipedrive](https://www.pipedrive.com/) API wrapper gem.  
+[![](https://img.shields.io/travis/rnitta/Paperdrive/master.svg?style=popout-square)](https://travis-ci.org/rnitta/Paperdrive)
+[![](https://img.shields.io/gem/v/Paperdrive.svg?style=popout-square)](https://rubygems.org/gems/Paperdrive)
+
+## Installation
+
+Add this line to your application's Gemfile (Recommended):
+
+```ruby
+gem 'paperdrive'
+```
+
+```shell
+$ bundle install
+```
+
+---
+
+Or install it on your global:
+
+```shell
+$ gem install paperdrive
+```
+
+## Document
+[YARD doc](https://paperdrive-doc.netlify.com/)
+
+## Usage
+
+First, you should get API Token from Pipedrive dashboard.
+
+Then,
+
+```ruby
+require 'paperdrive'
+
+client = Paperdrive::Client.new(token: 'your_token_here')
+# or setting token to ENV['PAPERDRIVE_TOKEN'] and you can initialize with `Paperdrive::Client.new`.
+
+response = client.all_activities(user_id: 1, done: 1)
+# => #<Paperdrive::Response> 
+
+pp response
+# =>
+# #<Paperdrive::Response:0x00007ff811221b70
+# @body=
+#   {"success"=>true,
+#    "data"=>
+#      [{"id"=>0,
+#        "company_id"=>000000,
+#        "user_id"=>000000,
+#        "done"=>false,
+#        "type"=>"call",
+#        "reference_type"=>nil,
+#        "reference_id"=>nil,
+#        "due_date"=>"2019-01-08",
+#        "due_time"=>"",
+#        "duration"=>"",
+#        "add_time"=>"2019-01-08 20:28:31",
+#        "marked_as_done_time"=>"",
+#        "last_notification_time"=>nil,
+#        "last_notification_user_id"=>nil,
+#        "notification_language_id"=>nil,
+#        "subject"=>"Call",
+#        ...
+
+response.success? #=> true
+
+```
+
+See `Paperdrive::Client` instance methods list [here (document)](https://paperdrive-doc.netlify.com/paperdrive/client)
+
+
+## Development
+
+Now developing, I appreciate your help.
+
+
+### TODO
+There are few APIs (mainly related to uploading files) still not wrapped.
+
+- ~~Activities~~ (implemented)
+- ~~ActivityFields~~ (implemented)
+- ~~ActivityTypes~~ (implemented)
+- Authorizations
+- ~~Currencies~~ (implemented)
+- ~~Deals~~ (implemented)
+- ~~DealFields~~ (implemented)
+- Files
+- ~~Filters~~ (implemented)
+- ~~GlobalMessages~~ (implemented)
+- ~~MailMessages~~ (implemented)
+- ~~MailThreads~~ (implemented)
+- ~~Notes~~ (implemented)
+- ~~NoteFields~~ (implemented)
+- ~~OrganizationFields~~ (implemented)
+- ~~Organizations~~ (implemented)
+- ~~OrganizationRelationships~~ (implemented)
+- ~~PermissionSets~~ (implemented)
+- Persons (almost implemented)
+- ~~PersonFields~~ (implemented)
+- ~~Pipelines~~ (implemented)
+- ~~Products~~ (implemented)
+- ~~ProductFields~~ (implemented)
+- ~~Recents~~ (implemented)
+- ~~Roles~~ (implemented)
+- ~~SearchResults~~ (implemented)
+- ~~Stages~~ (implemented)
+- ~~Users~~ (implemented)
+- ~~UserConnections~~ (implemented)
+- ~~UserSettings~~ (implemented)
+- ~~Webhooks~~ (implemented)
+
+- specs
+
+## Contributing
+
+Issue/Pull Request Please

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'paperdrive'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/paperdrive/client/activities.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+require 'paperdrive/parameters'
+
+module Paperdrive
+  class Client
+    # Instance methods related to Activities to embed into Paperdrive::Client<br>
+    # arguments are compatible with the Pipedribe API.
+    #
+    # @see https://developers.pipedrive.com/docs/api/v1/#!/Activities
+    module Activities
+      include Paperdrive::Parameters
+
+      # [GET] fetch Activities list
+      #
+      # @example
+      #   client.all_activities(type: 'task', start_date: '2020-05-01', done: 0)
+      #
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Activities/get_activities
+      # @return [Paperdrive::Response]
+      def all_activities(**args)
+        params = parameters(args) do
+          optional_params :user_id, :filter_id, :type, :start, :limit, :start_date, :end_date, :done
+        end
+        request(:get, 'activities', params)
+      end
+
+      # [GET] fetch a single activity
+      #
+      # @param [integer] id: ID of the activity to fetch
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Activities/get_activities_id
+      # @return [Paperdrive::Response]
+      def activity_detail(id:, **args)
+        params = parameters(args) do
+          optional_params
+        end
+        request(:get, "activities/#{id}", params)
+      end
+
+      # [POST] create a single activity
+      #
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Activities/post_activities
+      # @return [Paperdrive::Response]
+      def create_activity(**args)
+        params = parameters(args) do
+          required_params :subject, :type
+          optional_params :subject, :type, :done, :due_date, :due_time, :duration, :user_id, :deal_id, :person_id, :participants, :org_id, :note
+        end
+        request(:post, 'activities', params)
+      end
+
+      # [PUT] update a single activity
+      #
+      # @param [integer] id: ID of the actibity to update
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Activities/put_activities_id
+      # @return [Paperdrive::Response]
+      def edit_activity(id:, **args)
+        params = parameters(args) do
+          optional_params :subject, :type, :done, :due_date, :due_time, :duration, :user_id, :deal_id, :person_id, :participants, :org_id, :note
+        end
+        request(:put, "activities/#{id}", params)
+      end
+
+      # [DELETE] delete multiple activities
+      #
+      # @example Delete activities whose IDs are 1,2,3,4,5,6,7,8,9,10
+      #   client.delete_activities(ids: [*(1..10)])
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Activities/delete_activities
+      # @return [Paperdrive::Response]
+      def delete_activities(**args)
+        params = parameters(args) do
+          required_params :ids
+          optional_params :ids
+        end
+        request(:delete, 'activities', params)
+      end
+
+      # [DELETE] delete a single activity
+      #
+      # @example Delete the actibity whose id = 1
+      #   client.delete_activities(id: 1)
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Activities/delete_activities_id
+      # @return [Paperdrive::Response]
+      def delete_activity(id:, **args)
+        params = parameters(args) do
+          optional_params
+        end
+        request(:delete, "activities/#{id}", params)
+      end
+    end
+  end
+end

data/lib/paperdrive/client/activity_fields.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require 'paperdrive/parameters'
+
+module Paperdrive
+  class Client
+    # Instance methods related to ActivityFields to embed into Paperdrive::Client
+    #
+    # @see https://developers.pipedrive.com/docs/api/v1/#!/ActivityFields
+    module ActivityFields
+      include Paperdrive::Parameters
+
+      # [GET] fetch all fields for activity.
+      #
+      # @example
+      #   client.activity_fields.body
+      #   #=> {
+      #         "success": true,
+      #         "data": [
+      #           {
+      #             "id": 1,
+      #             "key": "id",
+      #             "name": "ID",
+      #              ....
+      #
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/ActivityFields/get_activityFields
+      # @return [Paperdrive::Response]
+      def all_activities(**args)
+        params = parameters(args) do
+          optional_params
+        end
+        request(:get, 'activityFields', params)
+      end
+    end
+  end
+end

data/lib/paperdrive/client/activity_types.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+require 'paperdrive/parameters'
+
+module Paperdrive
+  class Client
+    # Instance methods related to ActivityTypes to embed into Paperdrive::Client<br>
+    # arguments are compatible with the Pipedribe API.
+    #
+    # @see https://developers.pipedrive.com/docs/api/v1/#!/ActivityTypes
+    module ActivityTypes
+      include Paperdrive::Parameters
+
+      # [GET] fetch activity types list
+      #
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/ActivityTypes/get_activityTypes
+      # @return [Paperdrive::Response]
+      def all_activity_types(**args)
+        params = parameters(args) do
+          optional_params
+        end
+        request(:get, 'activityTypes', params)
+      end
+
+      # [POST] create an activity type
+      #
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/ActivityTypes/post_activityTypes
+      # @return [Paperdrive::Response]
+      def create_activity_type(**args)
+        params = parameters(args) do
+          required_params :name, :icon_key
+          optional_params :name, :icon_key, :color
+        end
+        request(:post, 'activityTypes', params)
+      end
+
+      # [PUT] update an activity type
+      #
+      # @param [integer] id: ID of the activity type to update
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/ActivityTypes/put_activityTypes_id
+      # @return [Paperdrive::Response]
+      def edit_activity_type(id:, **args)
+        params = parameters(args) do
+          optional_params :name, :icon_key, :color, :order_nr
+        end
+        request(:put, "activityTypes/#{id}", params)
+      end
+
+      # [DELETE] delete multiple activity types
+      #
+      # @example Delete activity types whose IDs are 1,2,3,4,5,6,7,8,9,10
+      #   client.delete_activity_types(ids: [*(1..10)])
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/ActivityTypes/delete_activityTypes
+      # @return [Paperdrive::Response]
+      def delete_activitiy_types(**args)
+        params = parameters(args) do
+          required_params :ids
+          optional_params :ids
+        end
+        request(:delete, 'activityTypes', params)
+      end
+
+      # [DELETE] delete an activity type
+      #
+      # @example Delete the activity type whose id = 1
+      #   client.delete_activity_types(id: 1)
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/ActivityTypes/delete_activityTypes_id
+      # @return [Paperdrive::Response]
+      def delete_activity_type(id:, **args)
+        params = parameters(args) do
+          optional_params
+        end
+        request(:delete, "activityTypes/#{id}", params)
+      end
+    end
+  end
+end

data/lib/paperdrive/client/currencies.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'paperdrive/parameters'
+
+module Paperdrive
+  class Client
+    # Instance methods related to Currencies to embed into Paperdrive::Client<br>
+    # arguments are compatible with the Pipedribe API.
+    #
+    # @see https://developers.pipedrive.com/docs/api/v1/#!/Currencies
+    module Currencies
+      include Paperdrive::Parameters
+
+      # [GET] fetch all supported currencies
+      #
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Currencies/get_currencies
+      # @return [Paperdrive::Response]
+      def all_currencies(**args)
+        params = parameters(args) do
+          optional_params :term
+        end
+        request(:get, 'currencies', params)
+      end
+    end
+  end
+end

data/lib/paperdrive/client/deal_fields.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+require 'paperdrive/parameters'
+
+module Paperdrive
+  class Client
+    # Instance methods related to DealFields to embed into Paperdrive::Client<br>
+    # arguments are compatible with the Pipedribe API.
+    #
+    # @see https://developers.pipedrive.com/docs/api/v1/#!/DealFields
+    module DealFields
+      include Paperdrive::Parameters
+
+      # [GET] Get all deal fields
+      #
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/DealFields/get_dealFields
+      # @return [Paperdrive::Response]
+      def all_deal_fields(**args)
+        params = parameters(args) do
+          optional_params :start, :limit
+        end
+        request(:get, 'dealFields', params)
+      end
+
+      # [GET] Get one deal field
+      #
+      # @param [integer] id:
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/DealFields/get_dealFields_id
+      # @return [Paperdrive::Response]
+      def deal_field(id:, **args)
+        params = parameters(args) do
+          optional_params
+        end
+        request(:get, "dealFields/#{id}", params)
+      end
+
+      # [POST] Add a new deal field
+      #
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/DealFields/post_dealFields
+      # @return [Paperdrive::Response]
+      def create_deal_field(**args)
+        params = parameters(args) do
+          required_params :name, :field_type
+          optional_params :name, :field_type, :options
+        end
+        request(:post, 'dealFields', params)
+      end
+
+      # [PUT] Update a deal field
+      #
+      # @param [integer] id:
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/DealFields/put_dealFields_id
+      # @return [Paperdrive::Response]
+      def update_deal_field(id:, **args)
+        params = parameters(args) do
+          required_params :name
+          optional_params :name, :options
+        end
+        request(:put, "dealFields/#{id}", params)
+      end
+
+      # [DELETE] Delete multiple deal fields in bulk
+      #
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/DealFields/delete_dealFields
+      # @return [Paperdrive::Response]
+      def delete_deal_fields(**args)
+        params = parameters(args) do
+          required_params :ids
+          optional_params :ids
+        end
+        request(:delete, 'dealFields', params)
+      end
+
+      # [DELETE] Delete a deal field
+      #
+      # @param [integer] id:
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/DealFields/delete_dealFields_id
+      # @return [Paperdrive::Response]
+      def delete_deal_field(id:, **args)
+        params = parameters(args) do
+          optional_params
+        end
+        request(:delete, "dealFields/#{id}", params)
+      end
+    end
+  end
+end