eventify_pro 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 29aecc530d08b11f6c5426524fe151cf64776c40
+  data.tar.gz: 695c9e9bf367ea9a59c282f2bc7ae3f0246376d3
+SHA512:
+  metadata.gz: 3b7b006a0011b24ac0ad2bc8abfe9d58f447b309d37d43f636cfd165f8e842dc1921a54e231a728ec34cd15b95b47bcc5f2923a1ed4634b0f13bae52685aacff
+  data.tar.gz: d185e4cddc80384e2dafa67a71f9e5857d67db4282b4660e64f20fbabd2588ed2e56f6a7ac23f800f740aeacb4f08fd961ed9580ff78f7353a61c5c48456d44c

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at makagon87@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Sergii Makagon
+
+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,115 @@
+[![Build Status](https://travis-ci.org/smakagon/eventify_pro.svg?branch=master)](https://travis-ci.org/smakagon/eventify_pro)
+
+# EventifyPro
+
+Client for [EventifyPro API](http://api.eventify.pro). Allows to publish events from Ruby-applications.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'eventify_pro'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install eventify_pro
+
+## Usage
+___
+### Getting Started:
+This guide assumes you have created an account and obtained an API key from [EventifyPro](http://eventify.pro)
+
+It's really easy to start publishing events with EventifyPro, just 2 lines of code:
+
+```ruby
+client = EventifyPro::Client.new(api_key: 'secret')
+client.publish(type: 'OrderCreated', data: { order_id: 1, amount: 500 })
+```
+
+### Ruby On Rails
+In a basic Ruby On Rails application you could create class under `lib` directory:
+
+```ruby
+# lib/eventify.rb
+
+class Eventify
+  def self.client
+    @client ||= EventifyPro::Client.new(api_key: 'secret', logger: Rails.logger)
+  end
+
+  def self.publish(event_type, data)
+    client.publish(type: event_type, data: data)
+  end
+end
+```
+Great, now to publish event from any place of your app use:
+
+```ruby
+Eventify.publish('UserSignedUp', user_id: 1, first_name: 'John', last_name: 'Doe')
+```
+
+* `type`: type of the event
+
+* `data`: key and value pairs pertaining to the event
+
+Don't forget to enable loading of the `lib` directory in application.rb file:
+
+```ruby
+# config/application.rb
+
+config.autoload_paths << Rails.root.join('lib')
+```
+___
+#### Example:
+```ruby
+class OrdersController < ApplicationController
+  def create
+    @order = Order.new(params[:order])
+
+    if @order.save
+      Eventify.publish(type: 'OrderCreated', data: { order_id: @order.id, amount: @order.amount })
+      redirect_to @order, notice: 'Post was successfully created.'
+    else
+      render :new
+    end
+  end
+end
+```
+___
+## Configuration
+
+#### `raise_errors:`
+* By default, `EventifyPro::Client` will swallow errors. It will return `true` or `false` depending on the result of publishing.
+* It's possible to pass `raise_errors: true`. In that case client will throw `EventifyPro::Error` exception if something went wrong.
+
+Example:
+```ruby
+client = EventifyPro::Client.new(api_key: 'secret', raise_errors: true)
+begin
+  client.publish(type: 'OrderCreated', data: { order_id: 1, amount: 1500 })
+rescue EventifyPro::Error
+  # exception handling
+end
+```
+
+#### `logger`
+* By default, client will use STDOUT to print error details.
+* You can provide any logger that responds to `.info(message)`. For example `Rails.logger`.
+
+Example:
+```ruby
+client = EventifyPro::Client.new(api_key: 'secret', logger: Rails.logger)
+```
+
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Eventify project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/smakagon/eventify/blob/master/CODE_OF_CONDUCT.md).

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'eventify'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/eventify_pro.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require 'eventify_pro/logger'
+require 'eventify_pro/client'
+require 'eventify_pro/version'

data/lib/eventify_pro/client.rb

@@ -0,0 +1,103 @@
+# frozen_string_literal: true
+
+require 'net/http'
+require 'uri'
+require 'json'
+
+# Eventify
+module EventifyPro
+  Error = Class.new(StandardError)
+  ServiceUnavailableError = Class.new(Error)
+
+  # EventifyPro::Client allows to publish events.
+  #
+  # To instantiate very basic client use this code:
+  # `client = EventifyPro::Client.new(api_key: 'personal_api_key')`
+  # Then use it this way:
+  # `client.publish(type: 'OrderPosted', data: { order_id: 10, amount: 3000 })`
+  #
+  # Configuration
+  #
+  # raise_errors:
+  # By default client will not throw any exception. `publish` will return either
+  # `true` or `false` depending on the result of publishing.
+  # It's possible to configure client to throw an `EventifyPro::Error`
+  # if exception wasn't published.
+  # `EventifyPro::Client.new(api_key: 'personal_api_key', raise_errors: true)`
+  #
+  # logger:
+  # By default client will write errors to STDOUT, but it's possible to pass
+  # any custom logger that responds to .info(message):
+  # `EventifyPro::Client.new(api_key: 'personal_api_key', logger: Rails.logger)`
+  class Client
+    BASE_URI = 'http://api.eventify.pro/v1'
+
+    def initialize(api_key: nil, raise_errors: false, logger: EventifyPro::DefaultLogger.new) # rubocop:disable LineLength
+      @api_key = api_key || ENV['EVENTIFY_PRO_API_KEY']
+      validate_api_key_presence!
+
+      @raise_errors = raise_errors
+      @logger = logger
+    end
+
+    def publish(type:, data:)
+      response = post_request('events', type, data)
+
+      error_message = response['error_message'] || ''
+      raise Error, error_message unless error_message.empty?
+
+      true
+    rescue => e
+      process_error(e, 'publish', type: type, data: data)
+      false
+    end
+
+    private
+
+    attr_reader :api_key, :raise_errors, :logger
+
+    def process_error(error, method, params)
+      error = Error.new('Could not publish event') unless error.is_a?(Error)
+      log_error(error.message, method, params)
+
+      raise error if raise_errors
+    end
+
+    def log_error(message, method, params)
+      message = "[EVENTIFY_PRO] ##{method} call returned error: #{message}\nParams: #{params}" # rubocop:disable LineLength
+      return logger.info(message) if logger.respond_to?(:info)
+
+      raise NotImplementedError, 'Logger should respond to #info(message) call'
+    end
+
+    def post_request(end_point, type, data)
+      url = "#{BASE_URI}/#{end_point}"
+
+      uri = URI.parse(url)
+      http = Net::HTTP.new(uri.host, uri.port)
+      request = Net::HTTP::Post.new(uri.path, headers)
+
+      request.set_form_data(type: type, data: data.to_json)
+
+      response = http.request(request)
+      JSON.parse(response.body)
+    rescue JSON::ParserError
+      raise Error, 'Could not process response from EventifyPro'
+    rescue
+      raise ServiceUnavailableError, 'EventifyPro is currently unavaliable'
+    end
+
+    def headers
+      {
+        'Authorization' => api_key,
+        'Content-Type' => 'application/json; charset=utf-8'
+      }
+    end
+
+    def validate_api_key_presence!
+      return unless api_key.to_s.empty?
+
+      raise Error, 'Please provide api_key param or set EVENTIFY_PRO_API_KEY environment variable' # rubocop:disable LineLength
+    end
+  end
+end

data/lib/eventify_pro/logger.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'logger'
+
+module EventifyPro
+  # Default Logger for EventifyPro::Client.
+  # Used if logger is not provided during client initialization
+  class DefaultLogger
+    def initialize
+      @logger = Logger.new(STDOUT)
+      @logger.level = Logger::INFO
+      @logger.datetime_format = '%Y-%m-%d %H:%M:%S '
+    rescue
+      false
+    end
+
+    def info(message)
+      @logger.info(message)
+    rescue
+      false
+    end
+  end
+end

data/lib/eventify_pro/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module EventifyPro
+  VERSION = '0.1.0'
+end

data/spec/client_spec.rb

@@ -0,0 +1,195 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe EventifyPro::Client do
+  let(:base_uri) { EventifyPro::Client::BASE_URI }
+
+  context '#publish' do
+    let(:event_type) { 'ProfileCreated' }
+    let(:event_data) { { name: 'John', email: 'john@doe.com' } }
+
+    let(:expected_request) do
+      {
+        body: { type: event_type, data: event_data.to_json },
+        headers: {
+          'Authorization' => 'secret',
+          'Content-Type' => 'application/x-www-form-urlencoded'
+        }
+      }
+    end
+
+    let(:response) do
+      '{
+         "id": "a98185f9-61a2-44f2-93d0-1dfd8f7a7790",
+         "type": "ProfileCreated",
+         "data": "{\"name\":  \"John\", \"email\":  \"john@doe.com\"}",
+         "created_at": "2017-06-07 18:28:59"
+      }'
+    end
+
+    let(:response_with_error) { '{ "error_message": "Invalid API key" }' }
+    let(:invalid_response) { 'foo' }
+
+    context 'with raise_errors = true' do
+      let(:client) do
+        described_class.new(api_key: 'secret', raise_errors: true)
+      end
+
+      context '#publish' do
+        context 'with successful response from API' do
+          it 'returns true' do
+            stub_request(:post, "#{base_uri}/events")
+              .with(expected_request).to_return(body: response, status: 200)
+
+            expect(
+              client.publish(type: event_type, data: event_data)
+            ).to be_truthy
+
+            expect(WebMock).to have_requested(:post, "#{base_uri}/events")
+              .with(expected_request).once
+          end
+        end
+
+        context 'with error response from API' do
+          it 'raises an EventifyPro::Error' do
+            stub_request(:post, "#{base_uri}/events")
+              .with(expected_request)
+              .to_return(body: response_with_error, status: 401)
+
+            expect do
+              client.publish(type: event_type, data: event_data)
+            end.to raise_error(EventifyPro::Error, 'Invalid API key')
+
+            expect(WebMock).to have_requested(:post, "#{base_uri}/events")
+              .with(expected_request).once
+          end
+        end
+
+        context 'with invalid response from API' do
+          it 'raises an EventifyPro::Error' do
+            stub_request(:post, "#{base_uri}/events")
+              .with(expected_request)
+              .to_return(body: invalid_response, status: 401)
+
+            expect do
+              client.publish(type: event_type, data: event_data)
+            end.to raise_error(
+              EventifyPro::Error, 'Could not process response from EventifyPro'
+            )
+
+            expect(WebMock).to have_requested(:post, "#{base_uri}/events")
+              .with(expected_request).once
+          end
+        end
+
+        context 'when API is unavailable' do
+          it 'raises an EventifyPro::ServiceUnavailableError' do
+            stub_request(:post, "#{base_uri}/events").to_timeout
+            expect do
+              client.publish(type: event_type, data: event_data)
+            end.to raise_error(
+              EventifyPro::ServiceUnavailableError,
+              'EventifyPro is currently unavaliable'
+            )
+            expect(WebMock).to have_requested(:post, "#{base_uri}/events")
+          end
+        end
+      end
+    end
+
+    context 'with raise_errors = false (default)' do
+      let(:client) { described_class.new(api_key: 'secret') }
+
+      context '#publish' do
+        context 'with successful response from API' do
+          it 'returns true' do
+            stub_request(:post, "#{base_uri}/events")
+              .with(expected_request).to_return(body: response, status: 200)
+
+            expect(
+              client.publish(type: event_type, data: event_data)
+            ).to be_truthy
+
+            expect(WebMock).to have_requested(:post, "#{base_uri}/events")
+              .with(expected_request).once
+          end
+        end
+
+        context 'with error response from API' do
+          it 'returns false' do
+            stub_request(:post, "#{base_uri}/events")
+              .with(expected_request)
+              .to_return(body: response_with_error, status: 401)
+
+            expect(client.publish(type: event_type, data: event_data)).to(
+              be_falsey
+            )
+
+            expect(WebMock).to have_requested(:post, "#{base_uri}/events")
+              .with(expected_request).once
+          end
+        end
+
+        context 'with invalid response from API' do
+          it 'returns false' do
+            stub_request(:post, "#{base_uri}/events")
+              .with(expected_request)
+              .to_return(body: invalid_response, status: 401)
+
+            expect(client.publish(type: event_type, data: event_data)).to(
+              be_falsey
+            )
+
+            expect(WebMock).to have_requested(:post, "#{base_uri}/events")
+              .with(expected_request).once
+          end
+        end
+
+        context 'when API is unavailable' do
+          it 'returns false' do
+            stub_request(:post, "#{base_uri}/events").to_timeout
+            expect(client.publish(type: event_type, data: event_data)).to(
+              be_falsey
+            )
+            expect(WebMock).to have_requested(:post, "#{base_uri}/events")
+          end
+        end
+      end
+    end
+
+    context 'logger' do
+      let(:expected_message) { "[EVENTIFY_PRO] #publish call returned error: Invalid API key\nParams: {:type=>\"ProfileCreated\", :data=>{:name=>\"John\", :email=>\"john@doe.com\"}}" } # rubocop:disable LineLength
+
+      before do
+        stub_request(:post, "#{base_uri}/events")
+          .with(expected_request)
+          .to_return(body: response_with_error, status: 401)
+      end
+
+      context 'with default logger' do
+        let(:client) { described_class.new(api_key: 'secret') }
+
+        it 'calls .info with error message' do
+          expect_any_instance_of(EventifyPro::DefaultLogger).to(
+            receive(:info).with(expected_message)
+          )
+          client.publish(type: event_type, data: event_data)
+        end
+      end
+
+      context 'with custom logger' do
+        let(:logger) { double('logger', info: true) }
+
+        let(:client) do
+          described_class.new(api_key: 'secret', logger: logger)
+        end
+
+        it 'calls .info with error message' do
+          expect(logger).to receive(:info).with(expected_message)
+          client.publish(type: event_type, data: event_data)
+        end
+      end
+    end
+  end
+end

data/spec/eventify_pro_spec.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe EventifyPro do
+  it 'has a version number' do
+    expect(EventifyPro::VERSION).not_to be nil
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'webmock/rspec'
+require 'eventify_pro'
+
+RSpec.configure do |config|
+  # Enable flags like --only-failures and --next-failure
+  config.example_status_persistence_file_path = '.rspec_status'
+
+  # Disable RSpec exposing methods globally on `Module` and `main`
+  config.disable_monkey_patching!
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: eventify_pro
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sergii Makagon
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-06-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.49'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.49'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+description: Allows to publish events from Ruby applications
+email:
+- makagon87@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CODE_OF_CONDUCT.md
+- LICENSE
+- README.md
+- bin/console
+- bin/setup
+- lib/eventify_pro.rb
+- lib/eventify_pro/client.rb
+- lib/eventify_pro/logger.rb
+- lib/eventify_pro/version.rb
+- spec/client_spec.rb
+- spec/eventify_pro_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/smakagon/eventify_pro
+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.10
+signing_key: 
+specification_version: 4
+summary: Client for EventifyPro API
+test_files:
+- spec/client_spec.rb
+- spec/eventify_pro_spec.rb
+- spec/spec_helper.rb