closeio-rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e7203477a04ff5ef6a351a70598b7106857e205c
+  data.tar.gz: 076170b93c9f9a57b2a4fbf1064af82b036bf37e
+SHA512:
+  metadata.gz: c19c337c975d042c456ee0bdf177ed051d27dc12053d801d745eb8935951fceadcc87934af3f9dc0cefd9c9ac67b879394cc0d1bea30a473ff73a3f36ff3ba7f
+  data.tar.gz: 461ea3a9bbb20485c6294a6cdfc0fbd45e8de8fc79ebab5247beadda0523df9f8e40e52a1ead202b5a473f643183242a3d7d85cf9a50414fabe9d9e1774a1543

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.ruby-gemset

@@ -0,0 +1 @@
+closeio_rails

data/.ruby-version

@@ -0,0 +1 @@
+2.4.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at ed@errorstudio.co.uk. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in close-rails.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Error Ltd
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,52 @@
+# Closeio::Rails
+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. 
+
+### `Closeio::Rails::Base`
+All the models inherit from `Closeio::Rails::Base`, which has a couple of mixins:
+
+#### `Closeio::Rails::Attributes`
+Make the model respond to `attributes()` - it returns a hash, like ActiveRecord
+
+#### `Closeio::Rails::DateCoercion`
+Parse the creation and update dates into datetime objects, and add `created_at()` and `updated_at()` methods which are in line with Rails norms.
+
+### `Closeio::Rails::Lead`
+This is where most of the action happens. Leads have contacts, of type `Closeio::Rails::Contact`
+
+### `Closeio::Rails::Contact`
+A contact entry in Close.io. Not accessible on its own; always created after a call to `Closeio::Lead
+
+### `Closeio::Rails::CustomField`
+It's often useful to create and update custom fields in Close.io programatically - changing the values of select lists and similar.
+ 
+### `Closeio::Rails::Note`
+This is a very lightweight wrapper around Close::Client#create_note.
+
+
+## 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.
+
+Mount your route like this:
+
+```
+mount Closeio::Rails::Engine => "/closeio" #this can be any path you like
+```
+
+That'll give you the following routes:
+
+```
+debug_webhooks GET  /webhooks/debug(.:format) closeio/rails/webhooks#debug {:format=>:json}
+webhooks POST /webhooks(.:format)       closeio/rails/webhooks#create {:format=>:json}
+```
+
+The `debug_webhooks_path` only works in development. It just sanity-checks that you've got ot mounted properly :)
+
+
+      
+
+
+
+

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

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

@@ -0,0 +1,31 @@
+module Closeio
+  module Rails
+    class WebhooksController < ApplicationController
+      skip_before_action :verify_authenticity_token, only: [:create]
+
+      # def closeio
+      #   if params[:model] == 'lead'
+      #     SyncUsersJob.perform_later params[:data][:id]
+      #   end
+      #   head :ok
+      # end
+
+      def create
+        request.format = :json
+        event = params[:event]
+        ActiveSupport::Notifications.instrument("closeio.#{event}", params)
+
+        #must return an ok - check Rails version to determine whether to return nothing or head response.
+        if ::Rails.version =~ /^4/
+          render nothing: true
+        else
+          head :ok
+        end
+      end
+
+      def debug
+        render json: {response: "It works - this is the debug method in Closeio::Rails::WebhooksController"}
+      end
+    end
+  end
+end

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

@@ -0,0 +1,8 @@
+module Closeio
+  module Rails
+    class Base < OpenStruct
+      include DateCoercion
+      include Attributes
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+module Closeio
+  module Rails
+    class Contact < Base
+
+      def has_login?
+        emails.find {|e| e['type'] == 'other'}.present?
+      end
+
+      def email
+        raise NotImplementedError, "You need to implement Closeio::Rails::Contact#email in your own subclass or prepended mixin."
+      end
+
+      def phone_numbers
+        phones.inject({}) {|h, p| h[p['phone_formatted']] = p['type']; h}
+      end
+
+      def email_addresses
+        emails.inject({}) {|h,data| h[data[:email]] = data[:type]; h}
+      end
+    end
+  end
+end

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

@@ -0,0 +1,43 @@
+module Closeio
+  module Rails
+    class CustomField < Base
+
+      def self.all
+        Closeio::Rails.configuration.client.list_custom_fields.collect do |field|
+          self.new(field)
+        end
+      end
+
+      def self.find(id)
+        self.new(Closeio::Rails.configuration.client.find_custom_field(id))
+      end
+
+      def self.create(params)
+        response = Closeio::Rails.configuration.client.create_custom_field(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 add_choice(choice)
+        new_choices = choices.push(choice)
+        Closeio::Rails.configuration.client.update_custom_field(id,choices: new_choices)
+      end
+
+      def remove_choice(choice)
+        new_choices = choices.reject {|c| c == choice}
+        Closeio::Rails.configuration.client.update_custom_field(id,choices: new_choices)
+      end
+
+      def set_all_choices(choices)
+        Closeio::Rails.configuration.client.update_custom_field(id,choices: choices)
+      end
+
+
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+module Closeio
+  module Rails
+    class Lead < Base
+      attr_reader :contacts
+
+      def self.all
+        Closeio::Rails.configuration.client.list_leads("*", per_page: 99999).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|
+          self.new(lead.to_hash)
+        end
+      end
+
+      def self.find(id)
+        self.new(Closeio::Rails.configuration.client.find_lead(id))
+      end
+
+      def self.create!(payload)
+        Closeio::Rails.configuration.client.create_lead(payload)
+      end
+
+      def contacts
+        @contacts ||= super.collect do |contact|
+          Contact.new(contact)
+        end
+      end
+
+
+    end
+  end
+end

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

@@ -0,0 +1,9 @@
+module Closeio
+  module Rails
+    class Note < Base
+      def self.create!(payload)
+        Closeio::Rails.configuration.client.create_note(payload)
+      end
+    end
+  end
+end

data/app/models/concerns/closeio/rails/attributes.rb

@@ -0,0 +1,11 @@
+module Closeio
+  module Rails
+    module Attributes
+      extend ActiveSupport::Concern
+
+      def attributes
+        to_h
+      end
+    end
+  end
+end

data/app/models/concerns/closeio/rails/date_coercion.rb

@@ -0,0 +1,16 @@
+module Closeio
+  module Rails
+    module DateCoercion
+      extend ActiveSupport::Concern
+      included do
+        def initialize(hash)
+          hash['date_created'] = DateTime.parse(hash['date_created'])
+          hash['date_updated'] = DateTime.parse(hash['date_updated'])
+          hash['created_at'] = hash['date_created']
+          hash['updated_at'] = hash['date_updated']
+          super
+        end
+      end
+    end
+  end
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "close/rails"
+
+# 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

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/close-rails.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'closeio/rails/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "closeio-rails"
+  spec.version       = Closeio::Rails::VERSION
+  spec.authors       = ["Ed Jones", "Paul Hendrick"]
+  spec.email         = ["ed@error.agency", "paul@error.agency"]
+
+  spec.summary       = %q{A wrapper around the closeio gem to provide some useful functionality in Rails}
+  spec.homepage      = "https://github.com/errorstudio/close-rails"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+
+  spec.add_dependency "require_all", "~> 1.3"
+  spec.add_dependency "closeio", "~> 2.6"
+  spec.add_dependency "rails", ">= 4.2", "< 6.0.0"
+
+end

data/config/routes.rb

@@ -0,0 +1,9 @@
+Closeio::Rails::Engine.routes.draw do
+  resources :webhooks, only: [:create], defaults: { format: :json } do
+    collection do
+      scope constraints: ->(request){ Rails.env.development? } do
+        get "/debug", to: "webhooks#debug"
+      end
+    end
+  end
+end

data/lib/closeio/rails/engine.rb

@@ -0,0 +1,15 @@
+module Closeio
+  module Rails
+    class Engine < ::Rails::Engine
+
+      isolate_namespace Closeio::Rails
+
+      config.before_initialize do
+
+      end
+
+      
+
+    end
+  end
+end

data/lib/closeio/rails/version.rb

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

data/lib/closeio/rails.rb

@@ -0,0 +1,30 @@
+require 'require_all'
+require_rel '.'
+
+module Closeio
+  module Rails
+
+    class << self
+      attr_accessor :configuration
+      def configure
+        self.configuration ||= Configuration.new
+        yield(configuration)
+        self.configuration.configure_connection
+      end
+    end
+
+    class Configuration
+      attr_accessor :api_key, :verbose
+      attr_reader :client
+
+      def configure_connection
+        @verbose ||= false
+        @client = Closeio::Client.new(@api_key, @verbose, nil, true)
+      end
+    end
+
+    class Error < StandardError
+
+    end
+  end
+end

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: closeio-rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ed Jones
+- Paul Hendrick
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-10-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: require_all
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: closeio
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+description: 
+email:
+- ed@error.agency
+- paul@error.agency
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-gemset"
+- ".ruby-version"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/controllers/closeio/rails/webhooks_controller.rb
+- app/models/closeio/rails/base.rb
+- app/models/closeio/rails/contact.rb
+- app/models/closeio/rails/custom_field.rb
+- app/models/closeio/rails/lead.rb
+- app/models/closeio/rails/note.rb
+- app/models/concerns/closeio/rails/attributes.rb
+- app/models/concerns/closeio/rails/date_coercion.rb
+- bin/console
+- bin/setup
+- close-rails.gemspec
+- config/routes.rb
+- lib/closeio/rails.rb
+- lib/closeio/rails/engine.rb
+- lib/closeio/rails/version.rb
+homepage: https://github.com/errorstudio/close-rails
+licenses:
+- MIT
+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.6.12
+signing_key: 
+specification_version: 4
+summary: A wrapper around the closeio gem to provide some useful functionality in
+  Rails
+test_files: []