zapier_ruby 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8141f429752055c586e7caa70087653279a331a3
+  data.tar.gz: 89a0de3442e99a0626e630cb79f2ef57798d5465
+SHA512:
+  metadata.gz: 1d29c01ee77188a0814b4b69384974d070d346b4b4f87c672ea0fafd37d0a68179aa3abab6cfaa6beb7ca1faecb80a43f267872e6bee82ef9935d76409a89efe
+  data.tar.gz: ae6669128464030bd5f7b0201f2abaf0ed549d67354fab91d92d64db12b99bbfa695a5af19f2c8d30e7542d0670e51e1fbf36a2e805d2010bafc51a75ee51d1f

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 David Peterson
+
+MIT License
+
+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,75 @@
+# ZapierRuby
+
+Zapier Ruby provides a simple wrapper to post a 'zap' to a Zapier (https://zapier.com) webhook from any Ruby application. You must first have a Zapier account and have created a webhook configured to 'catch hook'. This gem is useful for simple integrations, such as posting to slack when an event happens in your Rails app, or sending an email when your chef deploy has completed.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'zapier_ruby'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install zapier_ruby
+
+## Usage
+
+### General Usage
+First, configure ZapierRuby. Pass a hash of each of your zap webhooks you would like to integrate, you can also change the uri we post to or disable logging.
+
+```
+ZapierRuby.configure.do |c|
+  c.web_hooks = {example_zap: "webhook_id"}
+  c.enable_logging = false
+end
+```
+
+You can find the value to fill in for webhook id in the location highlighted below ('xxxxxx' in the green box) when configuring your Zap:
+
+![](https://github.com/pete2786/pete2786.github.io/blob/master/images/finding_webhook.png)
+
+Next, instantiate a Zapper for the webhook to hit. Then, use the `zap` method with hash of params and send it to the Zapier web hook.
+
+```
+zapper=ZapierRuby::Zapper.new(:example_zap)
+zapper.zap({hello: "world"})
+```
+
+Each param you send can be used by Zapier, so include all of the information required to complete the task.
+
+### Rails Usage
+If you are using ZapierRuby with Rails, I'd recommend using creating an initializer (ex. config/intializers/zapier_ruby.rb) and with the following:
+
+```
+ZapierRuby.configure.do |c|
+  c.web_hooks = {example_zap: "zap_webhook_id"}
+end
+```
+
+#### Example Usage
+
+If you do not have email configured for you application, you could send an email via a Zap to notify a new user that their account has been created.
+```
+class User < ActiveRecord::Base
+  after_create :welcome_new_user
+  
+  def welcome_new_user
+    ZapierRuby::Zapper.new(:welcome_new_user).zap(user.attributes)
+  end
+end
+```
+
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/zapier_ruby/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/zapier_ruby/config.rb

@@ -0,0 +1,26 @@
+module ZapierRuby
+  class Config
+    attr_accessor :base_uri, :web_hooks, :enable_logging, :logger
+
+    def initialize
+      self.base_uri = "https://zapier.com/hooks/catch/"
+      self.web_hooks = { example_webhook: "webhook_id" }
+      self.enable_logging = true
+      self.logger = Logger.new(STDOUT)
+    end
+
+    def configure_with(path_to_yaml_file)
+      begin
+        config_yaml = YAML::load(IO.read(path_to_yaml_file))
+        reconfigure(config_yaml)
+      rescue Exception => e
+        logger.error "YAML configuration file cannot be loaded. Using defaults. Error :#{e.message}"
+        return
+      end
+    end
+
+    def reconfigure(config = {})
+      config.keys.select{|k| respond_to?("#{k}=")}.each{|k| self.send("#{k}=", config[k])}
+    end
+  end
+end

data/lib/zapier_ruby/logger_decorator.rb

@@ -0,0 +1,18 @@
+module ZapierRuby
+  class LoggerDecorator < SimpleDelegator
+    attr_accessor :enable_logging
+
+    def initialize(enable_logging)
+      self.enable_logging = enable_logging
+      super(ZapierRuby.config.logger)
+    end
+
+    def error(message)
+      super if enable_logging
+    end
+
+    def info(message)
+      super if enable_logging
+    end
+  end
+end

data/lib/zapier_ruby/version.rb

@@ -0,0 +1,3 @@
+module ZapierRuby
+  VERSION = "0.0.1"
+end

data/lib/zapier_ruby/zapper.rb

@@ -0,0 +1,61 @@
+module ZapierRuby
+  class Zapper
+    attr_accessor :zap_name, :logger
+
+    def initialize(zap_name)
+      self.zap_name = zap_name
+      self.logger = LoggerDecorator.new(config.enable_logging)
+    end
+
+    def zap(params={})
+      unless zap_web_hook_id
+        logger.error "No zap configured for #{zap_name}. Configured webhooks: #{config.web_hooks.to_s}"
+        return false
+      end
+
+      logger.info "Zapping #{zap_name} with params: #{params.to_json}"
+      post_zap(params)
+    end
+
+    def post_zap(params)
+      begin
+        rest_client.post(params, zap_headers)
+        true
+      rescue Exception => e
+        logger.error "Unable to post to Zapier url: #{zap_url} with params: #{params.to_json}. Error: #{e.message}"
+        false
+      end
+    end
+    private :post_zap
+
+    def rest_client
+      @rest_client ||= RestClient::Resource.new(zap_url, ssl_version: 'TLSv1')
+    end
+    private :rest_client
+
+    def zap_web_hook_id
+      return @zap_web_hook if defined?(@zap_web_hook)
+
+      @zap_web_hook = config.web_hooks[zap_name]
+    end
+    private :zap_web_hook_id
+
+    def zap_headers
+      {
+        "Accept" => " application/json",
+        "Content-Type" => "application/json"
+      }
+    end
+    private :zap_headers
+
+    def zap_url
+      "#{config.base_uri}#{zap_web_hook_id}/"
+    end
+    private :zap_url
+
+    def config
+      ZapierRuby.config
+    end
+    private :config
+  end
+end

data/lib/zapier_ruby.rb

@@ -0,0 +1,25 @@
+require 'rest_client'
+require 'yaml'
+require 'delegate'
+require 'logger'
+
+require 'zapier_ruby/version'
+require 'zapier_ruby/logger_decorator'
+require 'zapier_ruby/config'
+require 'zapier_ruby/zapper'
+
+module ZapierRuby
+  class << self
+    attr_accessor :config
+  end
+
+  def self.configure
+    self.config ||= ZapierRuby::Config.new
+    yield(config) if block_given?
+  end
+
+  def self.configure_with(path_to_yaml_file)
+    self.config ||= ZapierRuby::Config.new
+    config.configure_with(path_to_yaml_file)    
+  end
+end

data/zapier_ruby.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'zapier_ruby/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "zapier_ruby"
+  spec.version       = ZapierRuby::VERSION
+  spec.authors       = ["David Peterson"]
+  spec.email         = ["pete2786@umn.edu"]
+  spec.summary       = %q{Simple gem to integrate Zapier webhooks with a Ruby project.}
+  spec.description   = %q{Simple gem to integrate Zapier webhooks with a Ruby project.}
+  spec.homepage      = "http://pete2786.github.io"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rest-client"
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: zapier_ruby
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- David Peterson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Simple gem to integrate Zapier webhooks with a Ruby project.
+email:
+- pete2786@umn.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/zapier_ruby.rb
+- lib/zapier_ruby/config.rb
+- lib/zapier_ruby/logger_decorator.rb
+- lib/zapier_ruby/version.rb
+- lib/zapier_ruby/zapper.rb
+- zapier_ruby.gemspec
+homepage: http://pete2786.github.io
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Simple gem to integrate Zapier webhooks with a Ruby project.
+test_files: []