artsy-eventservice 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f9768b5adc5dfcc97e16ce3cbfeb432d0e383ebb
+  data.tar.gz: 29ea4b53bdfb2a911707be6e2fa3ee71983c4efc
+SHA512:
+  metadata.gz: 751b9e5b2e459f028cc6ca17ca821459688cea0b028c26fa1b884b5f2a99acb6a364f90a6bffbba90e87928c43bddf06bd86989ef91237594a90476e8be39755
+  data.tar.gz: 7adf8370810145efd73ac6e877dede30e30a5a14a473f3a68d824bae4ba0c8f7108121289e12c27164c7b7bc492b36ed45a330daeb06fcdb800de49ae9927242

data/.gitignore

@@ -0,0 +1,50 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+
+cache: bundler
+
+rvm:
+  - 2.3.0

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+### 0.1.0 (12/29/2016)
+
+* Initial public release - [@ashkan18](https://github.com/askan18).

data/Gemfile

@@ -0,0 +1,14 @@
+source 'http://rubygems.org'
+
+ruby '2.3.0'
+
+gemspec
+
+gem 'rake'
+gem 'bunny' # for producing/consuming evets from RabbitMQ
+
+
+group :test do
+  gem 'rspec'
+  gem 'rspec-mocks'
+end

data/Gemfile.lock

@@ -0,0 +1,43 @@
+PATH
+  remote: .
+  specs:
+    artsy-eventservice (0.1.0)
+      bunny (~> 2.6.2)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    amq-protocol (2.0.1)
+    bunny (2.6.2)
+      amq-protocol (>= 2.0.1)
+    diff-lcs (1.2.5)
+    rake (12.0.0)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.4)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  artsy-eventservice!
+  bunny
+  rake
+  rspec
+  rspec-mocks
+
+RUBY VERSION
+   ruby 2.3.0p0
+
+BUNDLED WITH
+   1.12.5

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016 Artsy
+
+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,53 @@
+# Artsy EventService [![Build Status](https://travis-ci.org/artsy/artsy-eventservice.svg?branch=master)](https://travis-ci.org/artsy/artsy-eventservice)
+Ruby Gem for producing events in Artsy's event stream.
+
+## Installation
+Add following line to your Gemfile
+
+```
+gem 'artsy-eventservice'
+```
+
+## Usage
+Create events by inheriting from `Events::BaseEvent`. Override the properties that are different than `BaseEvent` and set extra `properties`.
+
+```ruby
+module Events
+  class ConversationEvent < Events::BaseEvent
+    def subject
+	    {
+	      id: @object.to_id,
+	      display: @object.to_name
+	    }
+      end
+    end
+
+    def properties
+      {
+        test_prop: 'testing'
+      }
+    end
+  end
+end
+```
+
+`Artsy::EventService` uses [Bunny](http://rubybunny.info/) to securly connect to RabbitMQ over ssl, make sure following environment variables are set in your project:
+```
+RABBITMQ_URL="something like amqps://<user>:<pass>@rabbitmq.artsy.net:<port>/<vhost>"
+RABBITMQ_CLIENT_CERT=base64 strict decoded
+RABBTIMQ_CLIENT_KEY=base64 strict decoded
+RABBITMQ_CA_CERT=base64 strict decoded
+```
+
+Call `post_event` with proper `topic` and `event`:
+```ruby
+Artsy::EventService.post_event(topic: 'testing', event: event_model)
+```
+
+
+# Contributing
+
+* Fork the project.
+* Make your feature addition or bug fix with tests.
+* Update CHANGELOG.
+* Send a pull request. Bonus points for topic branches.

data/Rakefile

@@ -0,0 +1,12 @@
+require 'rubygems'
+require 'bundler/gem_tasks'
+Bundler.setup(:default, :development)
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+task :default => :spec

data/artsy-eventservice.gemspec

@@ -0,0 +1,18 @@
+$:.push File.expand_path('../lib', __FILE__)
+
+require 'artsy-eventservice/version'
+
+Gem::Specification.new do |s|
+  s.name = 'artsy-eventservice'
+  s.version = Artsy::EventService::VERSION
+  s.authors = ['Ashkan Nasseri']
+  s.email = 'ashkan.nasseri@gmail.com'
+  s.platform = Gem::Platform::RUBY
+  s.required_rubygems_version = '>= 1.3.6'
+  s.files = `git ls-files`.split("\n")
+  s.require_paths = ['lib']
+  s.homepage = 'http://github.com/artsy/artsy-eventservice'
+  s.licenses = ['MIT']
+  s.summary = "Ruby Gem for producing events in Artsy's event stream"
+  s.add_dependency 'bunny', '~> 2.6.2'
+end

data/lib/artsy-eventservice.rb

@@ -0,0 +1,3 @@
+require 'artsy-eventservice/version'
+require 'artsy-eventservice/artsy/event_service'
+require 'artsy-eventservice/presenters/events/base_event'

data/lib/artsy-eventservice/artsy/event_service.rb

@@ -0,0 +1,36 @@
+require 'bunny'
+
+module Artsy
+  module EventService
+    def self.conn
+      @conn ||= Bunny.new(
+        ENV['RABBITMQ_URL'],
+        tls: true,
+        tls_cert: Base64.decode64(ENV['RABBITMQ_CLIENT_CERT'] || ''),
+        tls_key: Base64.decode64(ENV['RABBTIMQ_CLIENT_KEY'] || ''),
+        tls_ca_certificates: [Base64.decode64(ENV['RABBITMQ_CA_CERT'] || '')],
+        verify_peer: true
+      )
+    end
+
+    def self.post_event(topic:, event:)
+      return unless ENV['EVENT_STREAM_ENABLED']
+      raise 'Event missing topic or verb.' if event.verb.to_s.empty? || topic.to_s.empty?
+      conn.start
+      channel = conn.create_channel
+      exchange = channel.topic(topic, durable: true)
+      exchange.publish(
+        event.json,
+        routing_key: event.verb,
+        persistent: true,
+        content_type: 'application/json',
+        app_id: app_name
+      )
+      conn.close
+    end
+
+    def self.app_name
+      defined?(Rails) ? Rails.application.class.to_s.split('::').first : 'artsy'
+    end
+  end
+end

data/lib/artsy-eventservice/presenters/events/base_event.rb

@@ -0,0 +1,37 @@
+require 'json'
+
+module Events
+  class BaseEvent
+    attr_reader :verb, :subject, :object, :properties
+    def initialize(user: nil, action:, model:)
+      @subject = user
+      @verb = action
+      @object = model
+      @properties = nil
+    end
+
+    def subject
+      {
+        id: @subject.id.to_s || '',
+        display: @subject.to_s
+      } if @subject
+    end
+
+    def object
+      {
+        id: @object.id.to_s,
+        root_type: @object.class.to_s,
+        display: @object.to_s
+      } if @object
+    end
+
+    def json
+      JSON.generate({
+        verb: @verb,
+        subject: subject,
+        object: object,
+        properties: properties
+      })
+    end
+  end
+end

data/lib/artsy-eventservice/version.rb

@@ -0,0 +1,6 @@
+module Artsy
+  module EventService
+    VERSION = '0.1.0'
+  end
+end
+

data/spec/artsy-eventstream/artsy/event_service_spec.rb

@@ -0,0 +1,59 @@
+require 'spec_helper'
+require 'json'
+
+describe Artsy::EventService do
+  let(:event) { double("event") }
+
+  before do
+    allow(event).to receive_messages(
+      verb: 'testing',
+      json: JSON.generate(hello: true)
+    )
+  end
+  describe '#post_event' do
+    context 'event stream disabled' do
+      before do
+        ENV['EVENT_STREAM_ENABLED'] = nil
+      end
+      it 'does not call conn and post event' do
+        expect(Artsy::EventService).not_to receive(:conn)
+        Artsy::EventService.post_event(topic: 'test', event: event)
+      end
+    end
+
+    context 'event stream enabled' do
+      before do
+        ENV['EVENT_STREAM_ENABLED'] = 'true'
+      end
+      it 'fails when topic is empty' do
+        expect { Artsy::EventService.post_event(topic: nil, event: event)}.to raise_error 'Event missing topic or verb.'
+      end
+      it 'fails when event.verb is empty' do
+        allow(event).to receive(:verb).and_return('')
+        expect { Artsy::EventService.post_event(topic: 'test', event: event)}.to raise_error 'Event missing topic or verb.'
+      end
+      it 'fails when event.verb is nil' do
+        allow(event).to receive(:verb).and_return(nil)
+        expect { Artsy::EventService.post_event(topic: 'test', event: event)}.to raise_error 'Event missing topic or verb.'
+      end
+      it 'calls publish on the exchange with proper data' do
+        conn = double
+        expect(Artsy::EventService).to receive(:conn).at_least(3).times.and_return(conn)
+        expect(conn).to receive(:start).once
+        expect(conn).to receive(:close).once
+        channel = double
+        expect(conn).to receive(:create_channel).and_return(channel)
+        exchange = double
+        expect(channel).to receive(:topic).with('test', durable: true).and_return(exchange)
+        expect(exchange).to receive(:publish).with(
+          JSON.generate(hello: true),
+          routing_key: 'testing',
+          persistent: true,
+          content_type: 'application/json',
+          app_id: 'artsy'
+        )
+        Artsy::EventService.post_event(topic: 'test', event: event)
+      end
+    end
+  end
+end

data/spec/artsy-eventstream/presenters/events/base_event_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+describe Events::BaseEvent do
+  let(:model) { double('model') }
+  let(:user) { double('user') }
+  let(:event) { Events::BaseEvent.new(user: user, action: 'test', model: model) }
+  before do
+    allow(model).to receive_messages(
+      id: 'model-1',
+      to_s: 'Model 1'
+    )
+    allow(user).to receive_messages(
+      id: 'user-1',
+      to_s: 'User 1'
+    )
+  end
+  describe '#json' do
+    it 'returns proper json' do
+      expect(JSON.parse(event.json)).to match(
+        'verb' => 'test',
+        'subject' => {
+          'id' => 'user-1',
+          'display' => 'User 1'
+        },
+        'object' => {
+          'id' => 'model-1',
+          'root_type' => 'RSpec::Mocks::Double',
+          'display' => 'Model 1'
+        },
+        'properties' => nil
+      )
+    end
+  end
+end

data/spec/artsy-eventstream/version_spec.rb

@@ -0,0 +1,6 @@
+require 'spec_helper'
+describe Artsy::EventService do
+  it 'has a version' do
+    Artsy::EventService::VERSION.should_not be_nil
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'rubygems'
+require 'rspec'
+require 'artsy-eventservice'

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: artsy-eventservice
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ashkan Nasseri
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-12-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bunny
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.6.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.6.2
+description: 
+email: ashkan.nasseri@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- artsy-eventservice.gemspec
+- lib/artsy-eventservice.rb
+- lib/artsy-eventservice/artsy/event_service.rb
+- lib/artsy-eventservice/presenters/events/base_event.rb
+- lib/artsy-eventservice/version.rb
+- spec/artsy-eventstream/artsy/event_service_spec.rb
+- spec/artsy-eventstream/presenters/events/base_event_spec.rb
+- spec/artsy-eventstream/version_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/artsy/artsy-eventservice
+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: 1.3.6
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Ruby Gem for producing events in Artsy's event stream
+test_files: []