pipe_rocket 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 794070337cc9ed25712f6ec80fa6d541ca7d9af7bff8ff58003b8aba0c82c130
-  data.tar.gz: e04b4494afe552d89ed7f4bcaf4cd914a7828c9351649f286907e067fefbb02e
+  metadata.gz: c6bedc748fe28608525bb671fe7eedf03c5bbc0e5547b4dcae221b94a014c96e
+  data.tar.gz: 97661f23343b9cfd705b9212039c63c13956bdaca73e3731bfd2d527802aa670
 SHA512:
-  metadata.gz: 8002c294465b23428b1d79f8ca457a54428ed035463be531730c41b67494b06a410e2531b9afbe255785cdccc0224e4356213ba90d7766f14c106c96a3a0945b
-  data.tar.gz: 459b00f198b5a96d82f81e61bcf801833620a38d3aafdc44026304a584ff775347fd70e2aae14ded6d7a7f4533dac530a68577a91b337366268bcd2dfcd30660
+  metadata.gz: e1fc43d0728dac71a4fafa9c0dd4e2cf933aec20ee6a62ab0e986aa3078662afe74f943a396e21b1b196c97957401af4c1f7dac8105a9f44261685e55ca4e0ed
+  data.tar.gz: 3b4a31dc6b8838e2f66ef296aa42d34367d7b6bc754d9ac26762ed4f7043ed33fdf287a648e0b6719d471feb5dd9bf402a93094531783db0e4505217aeb43c7d

data/app/controllers/pipe_rocket/events_controller.rb

@@ -2,7 +2,8 @@ module PipeRocket
   class EventsController < ApplicationController
     skip_before_action :verify_authenticity_token
     def handle
-      ActiveSupport::Notifications.instrument "#{params[:object]}_#{params[:event]}", {params[:object].to_sym => "PipeRocket::#{params[:object].titleize}".constantize.new(params[:current])}
+      json = params[:current] || params[:previous]
+      ActiveSupport::Notifications.instrument "#{params[:object]}_#{params[:event]}", {params[:object].to_sym => "PipeRocket::#{params[:object].titleize}".constantize.new(json)}
     end
   end
 end

data/lib/pipe_rocket/deal.rb

@@ -4,6 +4,8 @@ require 'pipe_rocket/person'
 module PipeRocket
   class Deal < Entity
     attr_accessor :organization, :person
+
+    # Returns hash {custom_field_key: PipeRocket::Field object}
     def self.key_field_hash
       @@key_field_hash ||= Pipedrive.deal_fields.key_field_hash
     end
@@ -39,10 +41,12 @@ module PipeRocket
         end
     end
 
+    # Returns PipeRocket::Stage object corresponding to current deal stage
     def stage
       Pipedrive.stages.find(self.stage_id)
     end
 
+    # Returns stage name like PipelineName:StageName
     def display_stage_name
       self.stage.display_name
     end

data/lib/pipe_rocket/entity.rb

@@ -9,6 +9,7 @@ module PipeRocket
       end
     end
 
+    # Assign custom fields, using their names but not keys
     def assign_custom_fields(key_name_hash, entity_hash)
       names = key_name_hash.map do |key, field|
         name = field.name
@@ -28,6 +29,7 @@ module PipeRocket
       self.class.class_eval {attr_accessor *names}
     end
 
+    # Override custom field name if it present in CUSTOM_FIELD_NAMES
     def transform_field_name(key, name)
       hash = ::CUSTOM_FIELD_NAMES
       class_name = self.class.name.demodulize.underscore.to_sym

data/lib/pipe_rocket/field.rb

@@ -6,11 +6,13 @@ module PipeRocket
       @is_subfield ||= false
     end
 
+    # Return hash {option_id: option_value}
     def options_hash
       return {} unless @options
       @options.map{|option|{option['id'].to_s => option['label']}}.inject(:merge)
     end
-    
+
+    # Return value of field
     def value
       options_hash[option_id]
     end

data/lib/pipe_rocket/field_service.rb

@@ -6,14 +6,17 @@ module PipeRocket
       @resource_name = resource_name
     end
 
+    # Returns hash {custom_field_key: PipeRocket::Field object}
     def key_field_hash
       Pipedrive.send("#{@resource_name.split(/(?=[A-Z])/).first}_fields").all.select{|field|field.edit_flag || field.is_subfield}.map{|field|{field.key => field}}.inject(:merge) || {}
     end
 
+    # Returns hash {custom_field_key: custom_field_name}
     def key_name_hash
       Pipedrive.send("#{@resource_name.split(/(?=[A-Z])/).first}_fields").all.select{|field|field.edit_flag || field.is_subfield}.map{|field|{field.key => field.name}}.inject(:merge) || {}
     end
 
+    # Returns hash {custom_field_name: custom_field_key}
     def name_key_hash
       Pipedrive.send("#{@resource_name.split(/(?=[A-Z])/).first}_fields").all.select{|field|field.edit_flag || field.is_subfield}.map{|field|{field.name => field.key}}.inject(:merge) || {}
     end

data/lib/pipe_rocket/organization.rb

@@ -1,5 +1,6 @@
 module PipeRocket
   class Organization < Entity
+    # Returns hash {custom_field_key: PipeRocket::Field object}
     def self.key_field_hash
       @@key_field_hash ||= Pipedrive.organization_fields.key_field_hash
     end

data/lib/pipe_rocket/person.rb

@@ -2,6 +2,7 @@ module PipeRocket
   class Person < Entity
     attr_accessor :email, :phone, :organization, :id
 
+    # Returns hash {custom_field_key: PipeRocket::Field object}
     def self.key_field_hash
       @@key_field_hash ||= Pipedrive.person_fields.key_field_hash
     end
@@ -25,6 +26,6 @@ module PipeRocket
             nil
         end
       end
-    end      
+    end
   end
 end

data/lib/pipe_rocket/person_service.rb

@@ -6,6 +6,7 @@ module PipeRocket
       @resource_name = resource_name
     end
 
+    # Find person by email
     def find_by_email(email)
       uri = build_uri({term: email, search_by_email: true }, 'find')
       response = HTTP.get(uri)

data/lib/pipe_rocket/service.rb

@@ -21,10 +21,12 @@ module PipeRocket
       @has_custom_fields = RESOURCES_WITH_CUSTOM_FIELDS.include?(@resource_name)
     end
 
+    # Build resource_name class object from hash
     def build_entity(raw)
       "PipeRocket::#{@resource_name.titleize.delete(' ')}".constantize.new(raw)
     end
 
+    # Build uri for request
     def build_uri(params = {}, specificator = nil)
       params.merge!(api_token: ENV['pipedrive_api_token'])
       query_string = params.map{|k,v|"#{k}=#{v}"}.join('&')
@@ -32,6 +34,7 @@ module PipeRocket
       uri = URI("#{HOST}/#{plural_resource_name}/#{specificator}?#{query_string}")
     end
 
+    # Getting all @resource_name object from Pipedrive
     def all
       uri = build_uri
       response = HTTP.get(uri)
@@ -47,6 +50,7 @@ module PipeRocket
       raise PipeRocket::Error.new(408)
     end
 
+    # Create @resource_name in Pipedrive
     def create(params)
       uri = build_uri
       response = HTTP.post(uri, form: transform_custom_fields(params))
@@ -61,6 +65,7 @@ module PipeRocket
       raise PipeRocket::Error.new(408)
     end
 
+    # Find @resource_name object by id
     def find(id)
       uri = build_uri({}, id)
       response = HTTP.get(uri)
@@ -76,10 +81,12 @@ module PipeRocket
       raise PipeRocket::Error.new(408)
     end
 
+    # Getting first @resource_name object
     def first
       self.all.first
     end
 
+    # Update @resource_name object by id
     def update(id, params)
       uri = build_uri({}, id)
       response = HTTP.put(uri, form: transform_custom_fields(params))
@@ -96,6 +103,7 @@ module PipeRocket
 
     protected
 
+    # Trasform custom fields from their names to keys
     def transform_custom_fields(params)
       return params unless @has_custom_fields
 
@@ -120,13 +128,7 @@ module PipeRocket
       res
     end
 
-    def transform_field_name(key, name)
-      hash = ::CUSTOM_FIELD_NAMES
-      class_name = @resource_name
-      return name if hash.nil? || hash[class_name].nil? || hash[class_name].key(key.to_sym).nil?
-      hash[class_name][key.to_sym]
-    end
-
+    # Clear string from forbidden symbols for ruby variables
     def clear_key(key)
       key = key.underscore.gsub(' ','_')
       key = key.gsub('%','percent').gsub(/[^a-zA-Z0-9_]/,'')

data/lib/pipe_rocket/stage.rb

@@ -1,9 +1,11 @@
 module PipeRocket
   class Stage < Entity
+    # Return PipeRocket::Pipeline object which related with stage
     def pipeline
       Pipedrive.pipelines.find(self.pipeline_id)
     end
 
+    # Returns stage name like PipelineName:StageName
     def display_name
       "#{pipeline.name}:#{name}"
     end

data/lib/pipe_rocket.rb

@@ -10,38 +10,47 @@ require 'pipe_rocket/field_service'
 
 class Pipedrive
 
+  # Getting deal service object(PipeRocket::Servcice)
   def self.deals
     @@deals_service ||= PipeRocket::Service.new('deal')
   end
 
+  # Getting \deal_fields service object(PipeRocket::FieldServcice)
   def self.deal_fields
     @@deal_fields_service ||= PipeRocket::FieldService.new('dealField')
   end
 
+  # Getting note service object(PipeRocket::Servcice)
   def self.notes
     @@notes_service ||= PipeRocket::Service.new('note')
   end
 
+  # Getting organization service object(PipeRocket::Servcice)
   def self.organizations
     @@organizations_service ||= PipeRocket::Service.new('organization')
   end
 
+  # Getting \organization_field service object(PipeRocket::FieldServcice)
   def self.organization_fields
     @@organization_fields ||= PipeRocket::FieldService.new('organizationField')
   end
 
+  # Getting person service object(PipeRocket::PersonServcice)
   def self.persons
     @@persons_service ||= PipeRocket::PersonService.new('person')
   end
 
+  # Getting \person_field service object(PipeRocket::FieldServcice)
   def self.person_fields
     @@person_fields ||= PipeRocket::FieldService.new('personField')
   end
 
+  # Getting pipeline service object(PipeRocket::Servcice)
   def self.pipelines
     @@pipelines_service ||= PipeRocket::Service.new('pipeline')
   end
 
+  # Getting stages service object(PipeRocket::Servcice)
   def self.stages
     @@stages_service ||= PipeRocket::Service.new('stage')
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pipe_rocket
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Agafonov Maksim