binnacle_ar 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7b2429eb6a586aeb62ecb6a854d17bc247e0ee85
+  data.tar.gz: 3f7cfdcbe84eaa353582dedfcc0c21ce2a4101cf
+SHA512:
+  metadata.gz: adb0d30cf3dae08e782abd020f27efc99059fb9704529d9fa5194cee51d2be7f091bbcbefa84060894906e64421058b9537c0a711d5a4ea4c94dfaaf2cb6188f
+  data.tar.gz: 5831b8d36278f135037fd364881e2d9e0bccd1507fccbe57e67be949ecc1f9135bce92e2db789a5739ef13c9194da37d8d38e216e8f28fadcb98e6626a197dcd

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 Brian Sam-Bodden
+
+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.asc

@@ -0,0 +1,49 @@
+== binnacle_ar
+
+## Active Record CUD (Create-Update-Delete) interceptor for Binnacle
+
+....
+__/\\\______________________________________________________________________________/\\\\\\____________________
+ _\/\\\_____________________________________________________________________________\////\\\____________________
+  _\/\\\__________/\\\__________________________________________________________________\/\\\____________________
+   _\/\\\_________\///____/\\/\\\\\\_____/\\/\\\\\\_____/\\\\\\\\\_________/\\\\\\\\_____\/\\\_________/\\\\\\\\__
+    _\/\\\\\\\\\____/\\\__\/\\\////\\\___\/\\\////\\\___\////////\\\______/\\\//////______\/\\\_______/\\\/////\\\_
+     _\/\\\////\\\__\/\\\__\/\\\__\//\\\__\/\\\__\//\\\____/\\\\\\\\\\____/\\\_____________\/\\\______/\\\\\\\\\\\__
+      _\/\\\__\/\\\__\/\\\__\/\\\___\/\\\__\/\\\___\/\\\___/\\\/////\\\___\//\\\____________\/\\\_____\//\\///////___
+       _\/\\\\\\\\\___\/\\\__\/\\\___\/\\\__\/\\\___\/\\\__\//\\\\\\\\/\\___\///\\\\\\\\___/\\\\\\\\\___\//\\\\\\\\\\_
+        _\/////////____\///___\///____\///___\///____\///____\////////\//______\////////___\/////////_____\//////////__
+....
+
+Overview
+========
+Adds ActiveRecord callbacks for create, update and delete that will signal Binnacle
+with the state of the object (to_json)
+
+Setup
+=====
+Add the binnacle_ar gem to your Gemfile:
+
+```
+gem 'binnacle_ar'
+```
+
+Configure Binnacle Ruby driver by providing the values for endpoint, target context and
+a valid publisher's api key and secret:
+
+```
+BINNACLE_ENDPOINT=localhost
+BINNACLE_AR_CTX=26e5z3cybiv5tqj12zy6
+BINNACLE_API_KEY=nmp9wnfoj1t10spzi57r
+BINNACLE_API_SECRET=xsh3lanzk4oaqxcvho7d
+```
+
+Usage
+=====
+Use the `binnacle_signal` class method on an ActiveRecord model to decide on
+which actions to signal Binnacle:
+
+```
+class Comment < ActiveRecord::Base
+  binnacle_signal :on => [:create, :update, :destroy]
+end
+```

data/Rakefile

@@ -0,0 +1,7 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'bundler/gem_tasks'

data/lib/binnacle_ar.rb

@@ -0,0 +1,6 @@
+require "binnacle_ar/engine"
+require "binnacle"
+require "binnacle_ar/hooks"
+
+module BinnacleAr
+end

data/lib/binnacle_ar/engine.rb

@@ -0,0 +1,5 @@
+module BinnacleAr
+  class Engine < ::Rails::Engine
+    isolate_namespace BinnacleAr
+  end
+end

data/lib/binnacle_ar/hooks.rb

@@ -0,0 +1,51 @@
+module BinnacleAr
+  module Hooks
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def binnacle_signal(options = {})
+        options[:on] ||= [:create, :update, :destroy]
+
+        options_on = Array(options[:on])
+
+        after_create  :record_create if options_on.include?(:create)
+        after_update  :record_update if options_on.include?(:update)
+        after_destroy :record_destroy if options_on.include?(:destroy)
+
+        after_initialize do
+          @binnacle_client = Binnacle::Client.new(ENV['BINNACLE_API_KEY'], ENV['BINNACLE_API_SECRET'])
+        end
+
+        include BinnacleAr::Hooks::InstanceMethods
+      end
+    end
+
+    module InstanceMethods
+
+      private
+
+      def record_create
+        signal 'create'
+      end
+
+      def record_update
+        signal 'update'
+      end
+
+      def record_destroy
+        signal 'destroy'
+      end
+
+      def signal(method)
+        @binnacle_client.signal_asynch(ENV['BINNACLE_AR_CHANNEL'], "#{method}_#{self.class.to_s.underscore}",
+                                                   nil,
+                                                   nil,
+                                                   'INFO',
+                                                   [],
+                                                   self.to_json)
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.send :include, BinnacleAr::Hooks

data/lib/binnacle_ar/version.rb

@@ -0,0 +1,3 @@
+module BinnacleAr
+  VERSION = "0.0.2"
+end

metadata

@@ -0,0 +1,167 @@
+--- !ruby/object:Gem::Specification
+name: binnacle_ar
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Brian Sam-Bodden
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-04-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: binnacle
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.10
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.10
+- !ruby/object:Gem::Dependency
+  name: jquery-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.5
+- !ruby/object:Gem::Dependency
+  name: coffee-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.1.0
+- !ruby/object:Gem::Dependency
+  name: dotenv-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+- !ruby/object:Gem::Dependency
+  name: turbolinks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+description: |-
+  Adds ActiveRecord callbacks for create, update and delete that will signal Binnacle
+    with the state of the object (to_json)
+email:
+- brian@binnacle.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.asc
+- Rakefile
+- lib/binnacle_ar.rb
+- lib/binnacle_ar/engine.rb
+- lib/binnacle_ar/hooks.rb
+- lib/binnacle_ar/version.rb
+homepage: https://github.com/binnacle-io/binnacle_ar
+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.11
+signing_key: 
+specification_version: 4
+summary: ActiveRecord callbacks to signal Binnacle
+test_files: []