haz_webhooks 0.0.1 → 0.1.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
data/.gitignore CHANGED
@@ -1,17 +1,17 @@
1
- *.gem
2
- *.rbc
3
- .bundle
4
- .config
5
- .yardoc
6
- Gemfile.lock
7
- InstalledFiles
8
- _yardoc
9
- coverage
10
- doc/
11
- lib/bundler/man
12
- pkg
13
- rdoc
14
- spec/reports
15
- test/tmp
16
- test/version_tmp
17
- tmp
1
+ *.gem
2
+ *.rbc
3
+ .bundle
4
+ .config
5
+ .yardoc
6
+ Gemfile.lock
7
+ InstalledFiles
8
+ _yardoc
9
+ coverage
10
+ doc/
11
+ lib/bundler/man
12
+ pkg
13
+ rdoc
14
+ spec/reports
15
+ test/tmp
16
+ test/version_tmp
17
+ tmp
data/Gemfile CHANGED
@@ -1,4 +1,4 @@
1
- source 'https://rubygems.org'
2
-
3
- # Specify your gem's dependencies in haz_webhooks.gemspec
4
- gemspec
1
+ source 'https://rubygems.org'
2
+
3
+ # Specify your gem's dependencies in haz_webhooks.gemspec
4
+ gemspec
data/LICENSE.txt CHANGED
@@ -1,22 +1,22 @@
1
- Copyright (c) 2013 Cameron Sutter
2
-
3
- MIT License
4
-
5
- Permission is hereby granted, free of charge, to any person obtaining
6
- a copy of this software and associated documentation files (the
7
- "Software"), to deal in the Software without restriction, including
8
- without limitation the rights to use, copy, modify, merge, publish,
9
- distribute, sublicense, and/or sell copies of the Software, and to
10
- permit persons to whom the Software is furnished to do so, subject to
11
- the following conditions:
12
-
13
- The above copyright notice and this permission notice shall be
14
- included in all copies or substantial portions of the Software.
15
-
16
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17
- EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18
- MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
19
- NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
20
- LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
21
- OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
22
- WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
1
+ Copyright (c) 2013 Cameron Sutter
2
+
3
+ MIT License
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining
6
+ a copy of this software and associated documentation files (the
7
+ "Software"), to deal in the Software without restriction, including
8
+ without limitation the rights to use, copy, modify, merge, publish,
9
+ distribute, sublicense, and/or sell copies of the Software, and to
10
+ permit persons to whom the Software is furnished to do so, subject to
11
+ the following conditions:
12
+
13
+ The above copyright notice and this permission notice shall be
14
+ included in all copies or substantial portions of the Software.
15
+
16
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17
+ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18
+ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
19
+ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
20
+ LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
21
+ OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
22
+ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
data/README.md CHANGED
@@ -1,47 +1,60 @@
1
- # HazWebhooks
2
-
3
- Easily fire webhooks for any ActiveRecord model
4
-
5
- ## Installation
6
-
7
- Add this line to your application's Gemfile:
8
-
9
- gem 'haz_webhooks'
10
-
11
- And then execute:
12
-
13
- $ bundle
14
-
15
- Or install it yourself as:
16
-
17
- $ gem install haz_webhooks
18
-
19
- ## Usage
20
-
21
- add `haz_webhooks` to any ActiveRecord model with an array of events (arbitrary strings)
22
-
23
- class User < ActiveRecord::Base
24
- haz_webhooks ['post','update','score']
25
- end
26
-
27
- set the url
28
-
29
- User.find(1).webhooks.event('post').set('www.example.com/receive_webhook')
30
-
31
- fire the webhook
32
-
33
- data = {
34
- :id => post.id,
35
- :name => post.name,
36
- :poster => user.name
37
- }
38
-
39
- User.find(1).webhooks.event('post').fire(data)
40
-
41
- ## Contributing
42
-
43
- 1. Fork it
44
- 2. Create your feature branch (`git checkout -b my-new-feature`)
45
- 3. Commit your changes (`git commit -am 'Add some feature'`)
46
- 4. Push to the branch (`git push origin my-new-feature`)
47
- 5. Create new Pull Request
1
+ # HazWebhooks
2
+
3
+ Easily fire webhooks for any ActiveRecord model
4
+
5
+ ## Installation
6
+
7
+ Add this line to your application's Gemfile:
8
+
9
+ gem 'haz_webhooks'
10
+
11
+ And then execute:
12
+
13
+ $ bundle
14
+
15
+ Or install it yourself as:
16
+
17
+ $ gem install haz_webhooks
18
+
19
+ Then run:
20
+
21
+ rails generate haz_webhooks:install
22
+ rake db:migrate
23
+
24
+ ## Usage
25
+
26
+ add `haz_webhooks` to any ActiveRecord model with an array of events (arbitrary strings)
27
+
28
+ class User < ActiveRecord::Base
29
+ haz_webhooks ['post','update','score']
30
+ end
31
+
32
+ set the url
33
+
34
+ User.find(1).set_webhook('post', 'www.example.com/receive_webhook')
35
+
36
+ fire the webhook
37
+
38
+ data = {
39
+ :id => post.id,
40
+ :name => post.name,
41
+ :poster => user.name
42
+ }
43
+
44
+ User.find(1).fire_webhook('post', data)
45
+
46
+ See webhook url
47
+
48
+ User.find(1).webhook_url('score')
49
+
50
+ See Class webhook events (returns an array of strings)
51
+
52
+ User.webhook_events
53
+
54
+ ## Contributing
55
+
56
+ 1. Fork it
57
+ 2. Create your feature branch (`git checkout -b my-new-feature`)
58
+ 3. Commit your changes (`git commit -am 'Add some feature'`)
59
+ 4. Push to the branch (`git push origin my-new-feature`)
60
+ 5. Create new Pull Request
data/Rakefile CHANGED
@@ -1 +1 @@
1
- require "bundler/gem_tasks"
1
+ require "bundler/gem_tasks"
data/haz_webhooks.gemspec CHANGED
@@ -1,26 +1,26 @@
1
- # coding: utf-8
2
- lib = File.expand_path('../lib', __FILE__)
3
- $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
- require 'haz_webhooks/version'
5
-
6
- Gem::Specification.new do |spec|
7
- spec.name = "haz_webhooks"
8
- spec.version = HazWebhooks::VERSION
9
- spec.authors = ["Cameron Sutter"]
10
- spec.email = ["cameronsutter0@gmail.com"]
11
- spec.description = %q{Easily fire webhooks for any ActiveRecord model}
12
- spec.summary = %q{Webhooks for Rails}
13
- spec.homepage = "https://github.com/cameronsutter/haz_webhooks"
14
- spec.license = "MIT"
15
-
16
- spec.add_dependency "activerecord"
17
- spec.add_dependency "httparty"
18
-
19
- spec.files = `git ls-files`.split($/)
20
- spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
21
- spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
22
- spec.require_paths = ["lib"]
23
-
24
- spec.add_development_dependency "bundler", "~> 1.3"
25
- spec.add_development_dependency "rake"
26
- end
1
+ # coding: utf-8
2
+ lib = File.expand_path('../lib', __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require 'haz_webhooks/version'
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "haz_webhooks"
8
+ spec.version = HazWebhooks::VERSION
9
+ spec.authors = ["Cameron Sutter"]
10
+ spec.email = ["cameronsutter0@gmail.com"]
11
+ spec.description = %q{Easily fire webhooks for any ActiveRecord model}
12
+ spec.summary = %q{Webhooks for Rails}
13
+ spec.homepage = "https://github.com/cameronsutter/haz_webhooks"
14
+ spec.license = "MIT"
15
+
16
+ spec.add_dependency "activerecord"
17
+ spec.add_dependency "httparty"
18
+
19
+ spec.files = `git ls-files`.split($/)
20
+ spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
21
+ spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
22
+ spec.require_paths = ["lib"]
23
+
24
+ spec.add_development_dependency "bundler", "~> 1.3"
25
+ spec.add_development_dependency "rake"
26
+ end
@@ -0,0 +1,30 @@
1
+ require 'rails/generators'
2
+ require 'rails/generators/migration'
3
+
4
+ module HazWebhooks
5
+ class InstallGenerator < Rails::Generators::Base
6
+ include Rails::Generators::Migration
7
+
8
+ desc "Creates a migration which creates a webhooks table"
9
+
10
+ def self.source_root
11
+ File.join(File.dirname(__FILE__), 'templates')
12
+ end
13
+
14
+ def self.next_migration_number(dirname) #:nodoc:
15
+ if ActiveRecord::Base.timestamped_migrations
16
+ Time.now.utc.strftime("%Y%m%d%H%M%S")
17
+ else
18
+ "%.3d" % (current_migration_number(dirname) + 1)
19
+ end
20
+ end
21
+
22
+
23
+ # Every method that is declared below will be automatically executed when the generator is run
24
+
25
+ def create_migration_file
26
+ migration_file = File.join(File.dirname(__FILE__), 'templates', 'migration.rb')
27
+ migration_template migration_file, 'db/migrate/create_webhooks_table.rb'
28
+ end
29
+ end
30
+ end
@@ -0,0 +1,15 @@
1
+ class CreateWebhooksTable < ActiveRecord::Migration
2
+ def self.up
3
+ create_table :webhooks, :force => true do |t|
4
+ t.references :hook, :polymorphic => true
5
+ t.string :url
6
+ t.string :key
7
+ t.boolean :active
8
+ t.timestamps
9
+ end
10
+ end
11
+
12
+ def self.down
13
+ drop_table :webhooks
14
+ end
15
+ end
data/lib/haz_webhooks.rb CHANGED
@@ -1,8 +1,8 @@
1
- require "haz_webhooks/version"
2
- require "active_record"
3
- require "haz_webhooks/webhook"
4
- require "haz_webhooks/hook"
5
-
6
- module HazWebhooks
7
- # Your code goes here...
8
- end
1
+ require "haz_webhooks/version"
2
+ require "active_record"
3
+ require "haz_webhooks/webhook"
4
+ require "haz_webhooks/hook"
5
+
6
+ module HazWebhooks
7
+ # Your code goes here...
8
+ end
@@ -1,25 +1,55 @@
1
- module HazWebhooks
2
- module Actor
3
- extend ActiveSupport::Concern
4
-
5
- included do
6
- end
7
-
8
- module ClassMethods
9
- #events is an array of strings that are the key for the event
10
- def haz_webhooks(events)
11
- class_eval do
12
- has_many :webhooks, :class_name => 'HazWebhooks::Webhook'
13
- end
14
-
15
- #initialize with events
16
- events.each do |e|
17
- self.webhooks.create(:key => e)
18
- end
19
- end
20
- end
21
-
22
- end
23
- end
24
-
25
- ActiveRecord::Base.send :include, HazWebhooks::Actor
1
+ module HazWebhooks
2
+ module Hook
3
+ extend ActiveSupport::Concern
4
+
5
+ included do
6
+ end
7
+
8
+ module ClassMethods
9
+ #events is an array of strings that are the key for the event
10
+ def haz_webhooks(events)
11
+ class_eval do
12
+ has_many :webhooks, :as => :hook, :class_name => 'HazWebhooks::Webhook', :dependent => :delete_all
13
+ @@events = events
14
+ def webhook_events
15
+ @@events
16
+ end
17
+
18
+ after_create :init_webhooks
19
+ before_destroy :destroy_webhooks
20
+
21
+ def init_webhooks
22
+ @@events.each do |e|
23
+ self.webhooks.create(:key => e, :active => true)
24
+ end
25
+ end
26
+
27
+ def destroy_webhooks
28
+ self.webhooks.clear
29
+ end
30
+ end
31
+ end
32
+ end
33
+
34
+ def set_webhook(key, url)
35
+ hook = self.webhooks.event(key).first
36
+ if hook.nil?
37
+ self.webhooks.create(:key => key, :active => true, :url => url)
38
+ else
39
+ hook.set(url)
40
+ end
41
+ end
42
+
43
+ def fire_webhook(key, data)
44
+ hook = self.webhooks.event(key).first
45
+ hook.fire(data) if !hook.nil?
46
+ end
47
+
48
+ def webhook_url(key)
49
+ self.webhooks.event(key).first.try(:url)
50
+ end
51
+
52
+ end
53
+ end
54
+
55
+ ActiveRecord::Base.send :include, HazWebhooks::Hook
@@ -1,3 +1,3 @@
1
- module HazWebhooks
2
- VERSION = "0.0.1"
3
- end
1
+ module HazWebhooks
2
+ VERSION = "0.1.7"
3
+ end
@@ -1,24 +1,24 @@
1
- module HazWebhooks
2
- class Webhook < ::ActiveRecord::Base
3
- include HTTParty
4
- belongs_to :actor, :polymorphic => true
5
- attr_accessible :url, :key, :active
6
-
7
- def set(theURL)
8
- self.url = theURL
9
- save
10
- end
11
-
12
- def fire(data)
13
- Thread.new do
14
- post(url, :query => data)
15
- end
16
- end
17
-
18
- scope :active, where(:active => true)
19
-
20
- scope :event, lambda do |name|
21
- active.where(:key => name)
22
- end
23
- end
1
+ require 'httparty'
2
+
3
+ module HazWebhooks
4
+ class Webhook < ::ActiveRecord::Base
5
+ include HTTParty
6
+ belongs_to :hook, :polymorphic => true
7
+ attr_accessible :url, :key, :active, :hook_id
8
+
9
+ def set(theURL)
10
+ self.url = theURL
11
+ save
12
+ end
13
+
14
+ def fire(data)
15
+ Thread.new do
16
+ post(url, :query => data)
17
+ end
18
+ end
19
+
20
+ scope :active, where(:active => true)
21
+
22
+ scope :event, lambda {|name| active.where(:key => name)}
23
+ end
24
24
  end
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: haz_webhooks
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.0.1
4
+ version: 0.1.7
5
5
  prerelease:
6
6
  platform: ruby
7
7
  authors:
@@ -9,7 +9,7 @@ authors:
9
9
  autorequire:
10
10
  bindir: bin
11
11
  cert_chain: []
12
- date: 2013-07-12 00:00:00.000000000 Z
12
+ date: 2013-07-18 00:00:00.000000000 Z
13
13
  dependencies:
14
14
  - !ruby/object:Gem::Dependency
15
15
  name: activerecord
@@ -88,6 +88,8 @@ files:
88
88
  - README.md
89
89
  - Rakefile
90
90
  - haz_webhooks.gemspec
91
+ - lib/generators/haz_webhooks/install_generator.rb
92
+ - lib/generators/haz_webhooks/templates/migration.rb
91
93
  - lib/haz_webhooks.rb
92
94
  - lib/haz_webhooks/hook.rb
93
95
  - lib/haz_webhooks/version.rb
@@ -113,9 +115,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
113
115
  version: '0'
114
116
  requirements: []
115
117
  rubyforge_project:
116
- rubygems_version: 1.8.23
118
+ rubygems_version: 1.8.24
117
119
  signing_key:
118
120
  specification_version: 3
119
121
  summary: Webhooks for Rails
120
122
  test_files: []
121
- has_rdoc: