pipekit 2.0.0 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c29f137ec674dd92e5458ec82f4a637f4571da25
-  data.tar.gz: 0bca608dc9986d0549efd1a79c0dd7deb3cd8d0c
+  metadata.gz: 94dc04bff37594cd94b7ed1affd416a8275cc128
+  data.tar.gz: 0a25fdb3e60cf81fe1392076d90e2b5d38e65f2c
 SHA512:
-  metadata.gz: 341d2b409dda391fdd27a25fb2c215d8956910c99f6f2402f72cc1ef9991c47c67899903bd2cb6f7084a7d16ebe416d3b63f54de11e4e8c7afe0292f5076275d
-  data.tar.gz: 5e792c6a7523980c5a3ef917a7bebfe283f2e3ba80313dddc1f43d4f361c6587b2273cb662f792312936885f8341407ba1d0a2cf8399253533484a5ba0d27028
+  metadata.gz: 51e03e6d8f2c8e114e3af55a41c2c8beee47ea96a24fc7f39c1e35222301996ce207247f0039a2145eedc9e8d9a7747084b2863252ee676bafa6f148e3e1cbf8
+  data.tar.gz: 2978c25a5ce9faf34fd03950b642f6373bf5ef7d796ee4aae6b572486ca485033cb616f77a5ee6e16b487cbd5454102e636e01e157a46a6695afe532ad09dc84

data/README.md

@@ -36,6 +36,7 @@ The interface of Pipekit is organised around *repositories*. The available repos
 - Organization
 - Person
 - PersonField
+- Activity
 
 ### Resource repositories
 
@@ -91,6 +92,17 @@ note_repo = Pipekit::Note.new
 note_repo.update(123, {content: "Hey"})
 ```
 
+Add an Activity
+
+```ruby
+activity_repo.create(deal_id: 123,
+                     subject: "Interview Completed",
+                     done: 1,
+                     type: "pairing_session",
+                     duration: "00:45",
+                     note: "This was a fantastic interview")
+```
+
 ### Field repositories
 
 Pipedrive stores custom fields as key-value pairs. E.g. when you add an "Address" field to Persons Pipderive will store it as something like "050280e9bed01e55e25532f0b6e6228c748bf994"
@@ -144,4 +156,3 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/[USERN
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-

data/lib/pipekit.rb

@@ -13,6 +13,8 @@ require "pipekit/person_field"
 require "pipekit/deal_field"
 require "pipekit/note"
 require "pipekit/user"
+require "pipekit/activity"
+require "pipekit/resource_label"
 
 module Pipekit
 
@@ -25,4 +27,3 @@ module Pipekit
     Config.file_path = path
   end
 end
-

data/lib/pipekit/activity.rb

@@ -0,0 +1,7 @@
+module Pipekit
+  class Activity
+    include Repository
+    SINGULAR_CLASSNAME = "activity".freeze
+    PLURALIZED_CLASSNAME = "activities".freeze
+  end
+end

data/lib/pipekit/deal.rb

@@ -1,6 +1,8 @@
 module Pipekit
   class Deal
     include Repository
+    SINGULAR_CLASSNAME = "deal".freeze
+    PLURALIZED_CLASSNAME = "deals".freeze
 
     def get_by_person_id(person_id, person_repo: Person.new)
       raise UnknownPersonError, "No person ID supplied when getting deals by person ID" unless person_id

data/lib/pipekit/deal_field.rb

@@ -1,5 +1,8 @@
 module Pipekit
   class DealField
     include FieldRepository
+    # Pipedrive requires camelcase for resources
+    SINGULAR_CLASSNAME = "dealField".freeze
+    PLURALIZED_CLASSNAME = "dealFields".freeze
   end
 end

data/lib/pipekit/field_repository.rb

@@ -1,6 +1,7 @@
 module Pipekit
   module FieldRepository
     include Repository
+
     def get_by_key(key)
       key = Config.field_id(parent_resource, key)
       search_fields("key", key)
@@ -34,7 +35,7 @@ module Pipekit
     end
 
     def parent_resource
-      resource.chomp("Field")
+      resource.pluralized.chomp("Fields")
     end
 
   end

data/lib/pipekit/note.rb

@@ -1,5 +1,7 @@
 module Pipekit
   class Note
     include Repository
+    SINGULAR_CLASSNAME = "note".freeze
+    PLURALIZED_CLASSNAME = "notes".freeze
   end
 end

data/lib/pipekit/organization.rb

@@ -1,5 +1,7 @@
 module Pipekit
   class Organization
     include Repository
+    SINGULAR_CLASSNAME = "organization".freeze
+    PLURALIZED_CLASSNAME = "organizations".freeze
   end
 end

data/lib/pipekit/person.rb

@@ -1,6 +1,8 @@
 module Pipekit
   class Person
     include Repository
+    SINGULAR_CLASSNAME = "person".freeze
+    PLURALIZED_CLASSNAME = "persons".freeze
 
     def get_by_email(email)
       request.get("find", term: email, search_by_email: 1)

data/lib/pipekit/person_field.rb

@@ -1,5 +1,8 @@
 module Pipekit
   class PersonField
     include FieldRepository
+    # Pipedrive requires camelcase for resources
+    SINGULAR_CLASSNAME = "personField".freeze
+    PLURALIZED_CLASSNAME = "personFields".freeze
   end
 end

data/lib/pipekit/repository.rb

@@ -94,7 +94,9 @@ module Pipekit
     end
 
     def resource
-      self.class.to_s.split("::").last.tap { |name| name[0] = name[0].downcase }
+      singular_resource = self.class::SINGULAR_CLASSNAME
+      pluralized_resource = self.class::PLURALIZED_CLASSNAME
+      ResourceLabel.new(singular_label: singular_resource, pluralized_label: pluralized_resource)
     end
 
     def email_key?(options)

data/lib/pipekit/request.rb

@@ -25,7 +25,6 @@ module Pipekit
     # value - The value of the field.
     #
     # Examples
-    #
     #   search_by_field(field: :cohort, value: 119)
     #   search_by_field(field: :github_username, value: "octocat")
     #
@@ -73,15 +72,15 @@ module Pipekit
 
     def get_request(uri, query, start = 0)
       response = self.class.get(uri, options(query: {limit: pagination_limit, start: start}.merge(query)))
-      Result.new(resource, response)
+      Result.new(resource.singular, response)
     end
 
     def response_from(response_data)
-      Result.response(resource, response_data)
+      Result.response(resource.singular, response_data)
     end
 
     def uri(id = "")
-      "/#{resource}s/#{id}".chomp("/")
+      "/#{resource.pluralized}/#{id}".chomp("/")
     end
 
     def options(query: {}, body: {})
@@ -106,8 +105,8 @@ module Pipekit
     # meaning you don't have to worry about the custom IDs
     def parse_body(body)
       body.reduce({}) do |result, (field, value)|
-        value = Config.field_value_id(resource, field, value)
-        field = Config.field_id(resource, field)
+        value = Config.field_value_id(resource.singular, field, value)
+        field = Config.field_id(resource.singular, field)
         result.tap { |result| result[field] = value }
       end
     end
@@ -118,10 +117,10 @@ module Pipekit
 
     def search_by_field_query(field = nil, value = nil)
       {
-        field_type: "#{resource}Field",
-        field_key: Config.field_id(resource, field),
+        field_type: "#{resource.singular}Field",
+        field_key: Config.field_id(resource.singular, field),
         return_item_ids: true,
-        term: Config.field_value_id(resource, field, value),
+        term: Config.field_value_id(resource.singular, field, value),
         exact_match: 1
       }
     end

data/lib/pipekit/resource_label.rb

@@ -0,0 +1,12 @@
+module Pipekit
+  class ResourceLabel
+
+    attr_reader :singular, :pluralized
+
+    def initialize(singular_label:, pluralized_label:)
+      @singular = singular_label
+      @pluralized = pluralized_label
+    end
+
+  end
+end

data/lib/pipekit/user.rb

@@ -1,6 +1,8 @@
 module Pipekit
   class User
     include Repository
+    SINGULAR_CLASSNAME = "user".freeze
+    PLURALIZED_CLASSNAME = "users".freeze
 
     def get_by_email(email)
       request.get('find', term: email, search_by_email: 1)

data/lib/pipekit/version.rb

@@ -1,3 +1,3 @@
 module Pipekit
-  VERSION = "2.0.0"
+  VERSION = "2.1.1"
 end

data/pipekit.gemspec

@@ -1,24 +1,24 @@
 # coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'pipekit/version'
+require "pipekit/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "pipekit"
   spec.version       = Pipekit::VERSION
-  spec.authors       = ["jafrog", "pitchinvasion", "spike01", "danldb"]
-  spec.email         = ["irina@makersacademy.com", "leo@makersacademy.com", "spike@makersacademy.com", "dan@makersacademy.com"]
+  spec.authors       = ["jafrog", "pitchinvasion", "spike01", "dbugsy", "roidriscoll"]
+  spec.email         = ["dev@makersacademy.com"]
 
   spec.summary       = %q{Pipedrive API client for Ruby.}
-  spec.description   = %q{Pipedrive API client for Ruby.}
+  spec.description   = %q{Pipedrive API client for Ruby. Full API NOT implemented currently.}
   spec.homepage      = "https://github.com/makersacademy/pipekit"
   spec.license       = "MIT"
-  spec.required_ruby_version = '>= 1.9.1'
+  spec.required_ruby_version = ">= 1.9.1"
 
-  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the "allowed_push_host"
   # to allow pushing to a single host or delete this section to allow pushing to any host.
   if spec.respond_to?(:metadata)
-    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
   else
     raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
   end
@@ -34,6 +34,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.12"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "webmock", "~> 2.1.0"
+  spec.add_development_dependency "webmock"
   spec.add_development_dependency "pry"
 end

metadata

@@ -1,17 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: pipekit
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.1
 platform: ruby
 authors:
 - jafrog
 - pitchinvasion
 - spike01
-- danldb
+- dbugsy
+- roidriscoll
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-05-19 00:00:00.000000000 Z
+date: 2017-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -87,16 +88,16 @@ dependencies:
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.1.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.1.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -111,12 +112,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Pipedrive API client for Ruby.
+description: Pipedrive API client for Ruby. Full API NOT implemented currently.
 email:
-- irina@makersacademy.com
-- leo@makersacademy.com
-- spike@makersacademy.com
-- dan@makersacademy.com
+- dev@makersacademy.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -132,6 +130,7 @@ files:
 - bin/console
 - bin/setup
 - lib/pipekit.rb
+- lib/pipekit/activity.rb
 - lib/pipekit/config.rb
 - lib/pipekit/deal.rb
 - lib/pipekit/deal_field.rb
@@ -142,6 +141,7 @@ files:
 - lib/pipekit/person_field.rb
 - lib/pipekit/repository.rb
 - lib/pipekit/request.rb
+- lib/pipekit/resource_label.rb
 - lib/pipekit/response.rb
 - lib/pipekit/result.rb
 - lib/pipekit/user.rb
@@ -168,7 +168,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: Pipedrive API client for Ruby.