intercom_event_wrapper 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2b0abe404f7a0bcbce8b47cba2eedc18846b3c3a
+  data.tar.gz: 1d5fc8f53cabdfa610dbb82b2dad9b455ebf1c99
+SHA512:
+  metadata.gz: ad676bae938dd10268294b3c9815e5454eb4f75fbcfc46c9b113f06e58d4d27a55c31daf5a24205c436345f37244ab7ec33f18ec6d13554eb0b5018fb1f51e51
+  data.tar.gz: f1b5e1bc346e528cc1cbcb7988e3d7b71bc9735a58b607816eb1755f85595f0595332be34931ecfde4dd131caca79c5b4eb2099e19cdb00dde6cc9febe90683b

data/.gitignore

@@ -0,0 +1,12 @@
+doc
+*.gem
+*.iml
+.bundle
+Gemfile.lock
+pkg/*
+.rakeTasks
+.yardoc
+spike.rb
+html
+.idea
+*.swp

data/Gemfile

@@ -0,0 +1,8 @@
+source "http://rubygems.org"
+
+gem 'intercom'
+
+group :development, :test do
+  gem 'rspec'
+end
+

data/README.md

@@ -0,0 +1,38 @@
+# Intercom-ruby wrapper
+
+This is a simple wrapper to intercom that lets you create intercom events to multiple intercom apps from a single service. Unfortunately Intercom implementation of the ruby gem is a global singleton that demands ```app_id``` and ```app_api_key```. This means that you cannot use multiple intercom apps from within your application reliably.
+
+This gem overloads the ::Intercom::Event.create method, so you can pass app_id and app_api_key to it. This allows you to create intercom events to multiple intercom apps from a single service.
+
+# Installation
+
+Add these to your gemfile:
+```
+gem 'intercom'
+gem 'intercom_event_wrapper'
+```
+
+Require the gem somewhere
+```
+require 'intercom'
+require 'intercom_event_wrapper'
+```
+# Usage
+Before, if you wanted to use intercom api and wanted to create an event, you had to do something like this:
+```
+::Intercom.app_id = "your_app_id"
+::Intercom.app_api_key = "your_app_api_key"
+... # somewhere later
+::Intercom::Event.create your_event_data
+```
+
+However, if you wanted to create events to different apps from a single service, you had to change the ```app_id``` and ```app_api_key``` before use. This is prone to race conditions in an asynchronous or multithreaded program.
+
+With this wrapped you can instead just create an event like that
+```
+::Intercom::EventWrapper.create your_event_data, your_app_id, your_app_api_key
+```
+
+# Disclaimer
+
+You are free to use and modify this wrapper in any way you want. You can also send me (pull)requests to update or add something new to it. I, however, will take no responsibility over anything you do with this library.

data/intercom_event_wrapper.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |spec|
+  spec.name        = "intercom_event_wrapper"
+  spec.version     = "0.0.0"
+  spec.authors     = ["Stenver Jerkku"]
+  spec.email       = ["stenver1010@gmail.com"]
+  spec.summary     = %q{Wrapper for Intercom api, to get around the singleton restrictions that the original intercom gem imposes on you}
+  spec.description = %Q{This is a wrapper for Intercom ruby gem(https://github.com/intercom/intercom-ruby) that offers a way for the developer to fire intercom events to different interom apps from a single application or service. }
+  spec.license     = "MIT"
+  spec.homepage      = "https://github.com/stenver/intercom_event_wrapper"
+
+  spec.files         = `git ls-files`.split("\n")
+  spec.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  spec.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency 'rspec', '~>3'
+  spec.add_dependency 'intercom', '~>2.1'
+
+  spec.required_ruby_version = '~> 2.0'
+end

data/lib/intercom_event_wrapper.rb

@@ -0,0 +1,25 @@
+require 'intercom'
+require 'intercom_wrapper'
+require 'intercom/api_operations/save'
+require 'intercom/traits/api_resource'
+
+module Intercom
+  class EventWrapper < Event
+
+    def self.create(params, app_id, app_api_key)
+      instance = self.new(params)
+      instance.mark_fields_as_changed!(params.keys)
+      instance.save(app_id, app_api_key)
+    end
+
+    def save(app_id, app_api_key)
+      collection_name = Utils.resource_class_to_collection_name(self.class.superclass)
+      if id_present? && !posted_updates?
+        response = IntercomWrapper.put("/#{collection_name}/#{id}", to_submittable_hash, app_id, app_api_key)
+      else
+        response = IntercomWrapper.post("/#{collection_name}", to_submittable_hash.merge(identity_hash), app_id, app_api_key)
+      end
+      from_response(response) if response # may be nil we received back a 202
+    end
+  end
+end

data/lib/intercom_wrapper.rb

@@ -0,0 +1,34 @@
+require 'intercom'
+
+module IntercomWrapper
+  extend Intercom
+
+  def self.post(path, payload_hash, app_id, app_api_key)
+    send_request_to_path(Intercom::Request.post(path, payload_hash), app_id, app_api_key)
+  end
+
+  def self.put(path, payload_hash, app_id, app_api_key)
+    send_request_to_path(Intercom::Request.put(path, payload_hash), app_id, app_api_key)
+  end
+
+  def self.send_request_to_path(request, app_id, app_api_key)
+    request.execute(target_base_url(app_id, app_api_key))
+  rescue Intercom::ServiceUnavailableError => e
+    if Intercom::endpoints.length > 1
+      retry_on_alternative_endpoint(request, app_id, app_api_key)
+    else
+      raise e
+    end
+  end
+
+  def self.retry_on_alternative_endpoint(request, app_id, app_api_key)
+    Intercom.current_endpoint = Intercom::alternative_random_endpoint
+    request.execute(target_base_url, app_id, app_api_key)
+  end
+
+  def self.target_base_url(app_id, app_api_key)
+    raise ArgumentError, "#{Intercom.configuration_required_text} #{Intercom.related_docs_text}" if [app_id, app_api_key].any?(&:nil?)
+    basic_auth_part = "#{app_id}:#{app_api_key}@"
+    Intercom.current_endpoint.gsub(/(https?:\/\/)(.*)/, "\\1#{basic_auth_part}\\2")
+  end
+end

data/spec/intercom_wrapper/intercom_event_wrapper_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+require 'intercom_event_wrapper'
+require 'net/https'
+
+describe Intercom::EventWrapper do
+
+  let(:intercom_event_wrapper_class) { subject.intercom::EventWrapper }
+  let(:event) {{
+    event_name: "visitor-left",
+    user_id: 1,
+    created_at: Time.now
+  }}
+  let(:app_id) { "pi3243fa" }
+  let(:app_api_key) { "da39a3ee5e6b4b0d3255bfef95601890afd80709" }
+
+  # Since intercom doesnt provide free testing accounts, then this is the best test we can make.
+  # Not a very good one, but if we get unauthorized exception, then we can assume that the logic at least
+  # hit the right target
+  it 'sends an event to intercom' do
+    expect{::Intercom::EventWrapper.create event, app_id, app_api_key}.to raise_error(Intercom::AuthenticationError)
+  end
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: intercom_event_wrapper
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- Stenver Jerkku
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: intercom
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+description: 'This is a wrapper for Intercom ruby gem(https://github.com/intercom/intercom-ruby)
+  that offers a way for the developer to fire intercom events to different interom
+  apps from a single application or service. '
+email:
+- stenver1010@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.md
+- intercom_event_wrapper.gemspec
+- lib/intercom_event_wrapper.rb
+- lib/intercom_wrapper.rb
+- spec/intercom_wrapper/intercom_event_wrapper_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/stenver/intercom_event_wrapper
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Wrapper for Intercom api, to get around the singleton restrictions that the
+  original intercom gem imposes on you
+test_files:
+- spec/intercom_wrapper/intercom_event_wrapper_spec.rb
+- spec/spec_helper.rb