closeio-rails 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: e7203477a04ff5ef6a351a70598b7106857e205c
-  data.tar.gz: 076170b93c9f9a57b2a4fbf1064af82b036bf37e
+SHA256:
+  metadata.gz: 0b47e709d54fee2cc7a82b087ec14ac40d5c8365fa8f11d23cc6ec8cb3b553ce
+  data.tar.gz: 05e6e984037ae84ce6e406a1aebf518372c1dd03a17c1255b23783a1c6638e50
 SHA512:
-  metadata.gz: c19c337c975d042c456ee0bdf177ed051d27dc12053d801d745eb8935951fceadcc87934af3f9dc0cefd9c9ac67b879394cc0d1bea30a473ff73a3f36ff3ba7f
-  data.tar.gz: 461ea3a9bbb20485c6294a6cdfc0fbd45e8de8fc79ebab5247beadda0523df9f8e40e52a1ead202b5a473f643183242a3d7d85cf9a50414fabe9d9e1774a1543
+  metadata.gz: 2c42f9f9a5d2274a561c8279d3c40cb58f6ac729669fe6b48f8e07d53680aa7008a53e517d136a01c1df4a543c95a6292ff5ab59c95142283aaab9f811638ba8
+  data.tar.gz: 905d7004844dc3ee11b8e3c938f9d17de26337f646d2813560f5c033a0f11c6baf1dc9e69895db334681aeac2be55885c6c108e0c64fa389972fd70f85683176

data/README.md

@@ -2,7 +2,7 @@
 A handy wrapper around the `closeio` gem to make Rails integration a little easier.
 
 ## Models
-There are 4 models defined in this gem. The aim is to have a DSL a little more like the familiar ActiveRecord one. 
+There are 5 models defined in this gem. The aim is to have a DSL a little more like the familiar ActiveRecord one. 
 
 ### `Closeio::Rails::Base`
 All the models inherit from `Closeio::Rails::Base`, which has a couple of mixins:
@@ -25,6 +25,35 @@ It's often useful to create and update custom fields in Close.io programatically
 ### `Closeio::Rails::Note`
 This is a very lightweight wrapper around Close::Client#create_note.
 
+### `Closeio::Rails::Webhook`
+A similarly lightweight wrapper around Closeio::Client#create_webhook
+
+## Configuration
+Configure the gem in an initializer like this:
+
+```
+   Rails.application.config.to_prepare do
+     Closeio::Rails.configure do |config|
+         config.api_key = 'your key' #or put in Rails secrets, or somewhere else
+         config.verbose = false
+     end
+   end
+```
+
+You can add your own methods into the Closeio::Rails models by including them in your initializer like this:
+
+```
+    # Leadmethods and ContactMethods are modules in your Rails project. Obviously they could be namespaced, etc.
+     Closeio::Rails::Lead.send(:include, LeadMethods)
+     Closeio::Rails::Contact.send(:prepend, ContactMethods)
+```
+
+You might want to add actions to the webhooks controller, too. Sometimes we use this on applications with some sort of authentication defined in `ApplicationController`, which needs to be ignored on the webhooks controller:
+
+```
+     Closeio::Rails::WebhooksController.send(:skip_before_action, :authenticate_user!)
+     Closeio::Rails::WebhooksController.send(:skip_after_action, :verify_authorized)
+```
 
 ## Mountable webhooks controller
 It's useful to receive webhooks from Close.io. You have to drop a note to their support team to set it up but it's very quick.
@@ -44,6 +73,69 @@ webhooks POST /webhooks(.:format)       closeio/rails/webhooks#create {:format=>
 
 The `debug_webhooks_path` only works in development. It just sanity-checks that you've got ot mounted properly :)
 
+## Adding webhooks - rake tasks
+There are 3 rake tasks which are available to use in your application:
+
+### `rake closeio:rails:list_webhooks`
+Give you a list of webhooks with their ID and endpoint
+
+### `rake closeio:rails:create_lead_webhook[endpoint_url]`
+Sets up a webhook to track leads. Pass in an endpoint URL.
+
+### `rake closeio:rails:destroy_webhook[id]`
+Pass in the ID you got from `rake closeio:rails:list_webhooks` to destroy a webhook and no longer receive messages to that endpoint.
+
+## Adding other webhooks
+You can add other webhooks with different subscriptions by calling `Close::Rails::Webhook.create(params)` where params is a hash which looks like this:
+
+```
+Closeio::Rails::Webhook.create({
+        url: url,
+        events: [
+          {
+            object_type: 'lead',
+            action: 'created'
+          },
+          {
+            object_type: 'lead',
+            action: 'updated'
+          },
+          {
+            object_type: 'lead',
+            action: 'deleted'
+          },
+          {
+            object_type: 'lead',
+            action: 'merged'
+          }
+        ]
+       })
+    end
+```
+
+See [the docs](https://developer.close.com/#webhooks) for more details.
+
+### Consuming webhooks in your application
+The controller doesn't do anything when it receives a webhook - instead it uses ActiveSupport::Notifications to allow you to subscribe to the raised events to do what you need to. Here's an example:
+
+```
+ActiveSupport::Notifications.subscribe(/closeio\.(create|update|delete)/) do |name, start, finish, id, payload|
+  if payload[:model] == 'lead'
+    SomeLeadRelatedJob.perform_later payload[:data][:id]
+  end
+end
+```
+
+Check the Close.io docs to get a sense of what you get in the payload - one important thing to nose is that when you get a 'closeio.merge' notification, you don't get an ID, you'll get a `:source_id` and a `:destination_id`.
+
+Importantly, if you're using ActiveJob with the `inline` strategy you'll need to make sure you rescue from any failures, or the controller won't return a 200 OK and Close.io will keep retrying.
+
+# Contributing
+Pull requests welcome. The usual drill: fork, commit changes, PR.
+
+# Licence
+MIT - see LICENCE.txt.
+
 
       
 

data/app/controllers/closeio/rails/webhooks_controller.rb

@@ -12,8 +12,7 @@ module Closeio
 
       def create
         request.format = :json
-        event = params[:event]
-        ActiveSupport::Notifications.instrument("closeio.#{event}", params)
+        ActiveSupport::Notifications.instrument("closeio.#{params[:action]}", params)
 
         #must return an ok - check Rails version to determine whether to return nothing or head response.
         if ::Rails.version =~ /^4/

data/app/models/closeio/rails/lead.rb

@@ -4,13 +4,13 @@ module Closeio
       attr_reader :contacts
 
       def self.all
-        Closeio::Rails.configuration.client.list_leads("*", per_page: 99999).data.collect do |lead|
+        Closeio::Rails.configuration.client.list_leads("*", paginate: true)[:data].collect do |lead|
           self.new(lead.to_hash)
         end
       end
 
       def self.with_status(status)
-        Closeio::Rails.configuration.client.list_leads("lead_status: #{status}", per_page: 99999).data.collect do |lead|
+        Closeio::Rails.configuration.client.list_leads("lead_status: #{status}", paginate: true)[:data].collect do |lead|
           self.new(lead.to_hash)
         end
       end

data/app/models/closeio/rails/webhook.rb

@@ -0,0 +1,34 @@
+module Closeio
+  module Rails
+    class Webhook < Base
+      def self.all
+        Closeio::Rails.configuration.client.list_webhooks['data'].collect do |webhook|
+          self.new(webhook)
+        end
+      end
+
+      def self.create(params)
+        response = Closeio::Rails.configuration.client.create_webhook(params)
+        if response.has_key?('field-errors')
+          raise Closeio::Error, "#{response['field-errors']['name']}"
+        elsif response.has_key?('error')
+          raise Closeio::Error, "#{response['error']}"
+        else
+          response
+        end
+      end
+
+      def self.destroy!(id)
+        response = Closeio::Rails.configuration.client.delete_webhook(id)
+        if response.has_key?('field-errors')
+          raise Closeio::Error, "#{response['field-errors']['name']}"
+        elsif response.has_key?('error')
+          raise Closeio::Error, "#{response['error']}"
+        else
+          response
+        end
+
+      end
+    end
+  end
+end

data/close-rails.gemspec

@@ -24,7 +24,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake", "~> 10.0"
 
   spec.add_dependency "require_all", "~> 1.3"
-  spec.add_dependency "closeio", "~> 2.6"
+  spec.add_dependency "closeio", "~>3.5"
   spec.add_dependency "rails", ">= 4.2", "< 6.0.0"
 
 end

data/lib/closeio/rails.rb

@@ -1,3 +1,4 @@
+require 'closeio'
 require 'require_all'
 require_rel '.'
 

data/lib/closeio/rails/version.rb

@@ -1,5 +1,5 @@
 module Closeio
   module Rails
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

data/lib/tasks/webhooks.rake

@@ -0,0 +1,43 @@
+namespace :closeio do
+  namespace :rails do
+    desc "List webhooks"
+    task list_webhooks: :environment do
+      Closeio::Rails::Webhook.all.each do |webhook|
+        puts "id:#{webhook.id} endpoint:#{webhook.url}"
+      end
+    end
+
+    desc "Create webhook with defined endpoints"
+    task :create_leads_webhook, [:endpoint] => :environment do |task, args|
+      url = args[:endpoint]
+      raise Closeio::Rails::Error, "You need to include an endpoint URL or have configured the default URL for your environment" unless url.present?
+      Closeio::Rails::Webhook.create({
+        url: url,
+        events: [
+          {
+            object_type: 'lead',
+            action: 'created'
+          },
+          {
+            object_type: 'lead',
+            action: 'updated'
+          },
+          {
+            object_type: 'lead',
+            action: 'deleted'
+          },
+          {
+            object_type: 'lead',
+            action: 'merged'
+          }
+        ]
+                                   })
+    end
+
+    desc "Remove a webhook by ID"
+    task :destroy_webhook, [:id] => :environment do |task, args|
+      raise Closeio::Rails::Error, "You need to include a webhook subscription ID to destroy it" unless args[:id].present?
+      Closeio::Rails::Webhook.destroy!(args[:id])
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: closeio-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Ed Jones
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-10-08 00:00:00.000000000 Z
+date: 2019-05-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -59,14 +59,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.6'
+        version: '3.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.6'
+        version: '3.5'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -109,6 +109,7 @@ files:
 - app/models/closeio/rails/custom_field.rb
 - app/models/closeio/rails/lead.rb
 - app/models/closeio/rails/note.rb
+- app/models/closeio/rails/webhook.rb
 - app/models/concerns/closeio/rails/attributes.rb
 - app/models/concerns/closeio/rails/date_coercion.rb
 - bin/console
@@ -118,6 +119,7 @@ files:
 - lib/closeio/rails.rb
 - lib/closeio/rails/engine.rb
 - lib/closeio/rails/version.rb
+- lib/tasks/webhooks.rake
 homepage: https://github.com/errorstudio/close-rails
 licenses:
 - MIT
@@ -138,7 +140,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: A wrapper around the closeio gem to provide some useful functionality in