keikokuc 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

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

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Harold Giménez
+
+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,29 @@
+# Keikokuc
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'keikokuc'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install keikokuc
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/keikokuc.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/keikokuc/version', __FILE__)
+require 'factory_girl'
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Harold Giménez"]
+  gem.email         = ["harold.gimenez@gmail.com"]
+  gem.description   = %q{Keikoku API client}
+  gem.summary       = %q{Keikoku API client}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "keikokuc"
+  gem.require_paths = ["lib"]
+  gem.version       = Keikokuc::VERSION
+
+  gem.add_dependency 'rest-client'
+  gem.add_dependency 'yajl-ruby'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'factory_girl'
+  gem.add_development_dependency 'sham_rack'
+end

data/lib/handles_timeout.rb

@@ -0,0 +1,20 @@
+module HandlesTimeout
+  def self.included(base)
+    base.extend ClassMethods
+  end
+
+  RequestTimeout = Class.new
+
+  module ClassMethods
+    def handle_timeout(method_name)
+      alias_method "#{method_name}_without_timeout", method_name
+      define_method method_name do |args|
+        begin
+          Timeout::timeout(5) { send("#{method_name}_without_timeout", args) }
+        rescue Timeout::Error
+          [nil, RequestTimeout]
+        end
+      end
+    end
+  end
+end

data/lib/keikokuc/client.rb

@@ -0,0 +1,76 @@
+require 'rest-client'
+require 'yajl'
+require 'timeout'
+
+# Internal: Handles HTTP requests/responses to the keikoku API
+#
+# This class is meant to be used internally by Keikokuc
+class Keikokuc::Client
+  include HandlesTimeout
+
+  InvalidNotification = Class.new
+  Unauthorized = Class.new
+
+  attr_accessor :producer_api_key
+
+  def initialize(opts = {})
+    @producer_api_key = opts[:producer_api_key]
+  end
+
+  # Internal: posts a new notification to keikoku
+  #
+  # attributes - a hash containing notification attributes
+  #
+  # Examples
+  #
+  #   client = Keikokuc::Client.new(producer_api_key: 'abcd')
+  #   response, error = client.post_notification(message: 'hello')
+  #
+  # Returns
+  #
+  # two objects:
+  #   The response as a hash
+  #   The error if any (nil if no error)
+  #
+  # Possible errors include:
+  #
+  # * `Client::Timeout` if the request takes longer than 5 seconds
+  # * `Client::InvalidNotification` if the response indicates
+  #   invalid notification attributes
+  # * `Client::Unauthorized` if API key auth fails
+  def post_notification(attributes)
+    begin
+      response = notifications_api.post(encode_json(attributes), {'X-KEIKOKU-AUTH' => producer_api_key})
+      [parse_json(response), nil]
+    rescue RestClient::UnprocessableEntity => e
+      [parse_json(e.response), InvalidNotification]
+    rescue RestClient::Unauthorized => e
+      [{}, Unauthorized]
+    end
+  end
+  handle_timeout :post_notification
+
+private
+  def notifications_api # :nodoc:
+    @notifications_api ||= RestClient::Resource.new(api_url)
+  end
+
+  def api_url # :nodoc:
+    "https://keikoku.herokuapp.com/api/v1/notifications"
+  end
+
+  def encode_json(hash) # :nodoc:
+    Yajl::Encoder.encode(hash)
+  end
+
+  def parse_json(data) # :nodoc:
+    symbolize_keys(Yajl::Parser.parse(data)) if data
+  end
+
+  def symbolize_keys(hash) # :nodoc:
+    hash.inject({}) do |result, (k, v)|
+      result[k.to_sym] = v
+      result
+    end
+  end
+end

data/lib/keikokuc/notification.rb

@@ -0,0 +1,71 @@
+# Public: Encapsulates a keikoku notification
+#
+# This is the entry point for dealing with notifications
+#
+# Examples
+#
+#   notification = Keikokuc::Notification.new(message: 'hello',
+#                                             severity: 'info',
+#                                             target: 'sunny-skies-42'
+#                                             producer_api_key: 'abcd')
+#   if notificaiton.publish
+#     # persist notification
+#   else
+#     # handle error
+#   end
+#
+class Keikokuc::Notification
+  ATTRS = %w[message target severity url
+    producer_api_key remote_id errors].freeze
+
+  attr_accessor *ATTRS
+
+  # Public: class constructor
+  #
+  # opts - a hash of attributes to be set on constructed object
+  #
+  # Examples
+  #
+  #   notification = Keikokuc::Notification.new(message: 'hello')
+  #
+  # All keys on matching ATTRS will be set
+  def initialize(opts = {})
+    ATTRS.each do |attribute|
+      if opts.has_key?(attribute.to_sym)
+        send("#{attribute}=", opts[attribute])
+      end
+    end
+  end
+
+  # Public: publishes this notification to keikoku
+  #
+  # This method sets the `remote_id` attribute if it succeeds.
+  # If it fails, the `errors` hash will be populated.
+  #
+  # Returns a boolean set to true if publishing succeeded
+  def publish
+    response, error = client.post_notification(to_hash)
+    if error.nil?
+      self.remote_id = response[:id]
+      self.errors = nil
+    elsif error == Keikokuc::Client::InvalidNotification
+      self.errors = response[:errors]
+    end
+    error.nil?
+  end
+
+  # Internal: coerces this notification to a hash
+  #
+  # Returns this notification's attributes as a hash
+  def to_hash
+    ATTRS.inject({}) do |h, attribute|
+      h[attribute.to_sym] = send(attribute)
+      h
+    end
+  end
+
+private
+  def client # :nodoc:
+    @client ||= Keikokuc::Client.new(producer_api_key: producer_api_key)
+  end
+end

data/lib/keikokuc/version.rb

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

data/lib/keikokuc.rb

@@ -0,0 +1,7 @@
+require 'handles_timeout'
+require 'keikokuc/version'
+require 'keikokuc/client'
+require 'keikokuc/notification'
+
+module Keikokuc
+end

data/spec/factories.rb

@@ -0,0 +1,9 @@
+FactoryGirl.define do
+  factory :notification, class: Keikokuc::Notification do
+    skip_create
+
+    message  'Your database is over limits'
+    target   'cloudy-skies-243'
+    severity 'info'
+  end
+end

data/spec/keikoku/client_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+require 'sham_rack'
+module Keikokuc
+  describe Client, '#post_notification' do
+    let(:fake_keikoku) { FakeKeikoku.new }
+
+    after { ShamRack.unmount_all }
+
+    it 'publishes a new notification' do
+      ShamRack.mount(fake_keikoku, "keikoku.herokuapp.com", 443)
+      fake_keikoku.register_publisher({api_key: 'abc'})
+      client = Client.new(producer_api_key: 'abc')
+      result, error = client.post_notification(message:  'hello',
+                                               severity: 'info')
+      result[:id].should_not be_nil
+      error.should be_nil
+    end
+
+    it 'handles invalid notifications' do
+      ShamRack.at('keikoku.herokuapp.com', 443) do |env|
+        [422, {}, StringIO.new(Yajl::Encoder.encode({ errors: :srorre }))]
+      end
+
+      response, error = Client.new.post_notification({})
+      error.should == Client::InvalidNotification
+      response[:errors].should == 'srorre'
+    end
+
+    it 'handles authentication failures' do
+      ShamRack.mount(fake_keikoku, "keikoku.herokuapp.com", 443)
+      fake_keikoku.register_publisher({api_key: 'abc'})
+      client = Client.new(producer_api_key: 'bad one')
+      result, error = client.post_notification(message:  'hello',
+                                               severity: 'info')
+      result[:id].should be_nil
+      error.should == Client::Unauthorized
+    end
+
+    it 'handles timeouts' do
+      RestClient::Resource.any_instance.stub(:post).and_raise Timeout::Error
+      response, error = Client.new.post_notification({})
+      response.should be_nil
+      error.should == Client::RequestTimeout
+    end
+  end
+end

data/spec/keikoku/notification_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+
+module Keikokuc
+  describe Notification, '#publish' do
+    it 'publishes to keikoku and stores an id' do
+      fake_client = double
+      Client.stub(new: fake_client)
+      fake_client.
+        should_receive(:post_notification).with do |args|
+          args[:message].should == 'hello'
+        end.
+        and_return([{ id: 1 }, nil])
+
+      notification = build(:notification, message: 'hello')
+
+      result = notification.publish
+      result.should be_true
+
+      notification.remote_id.should == 1
+    end
+
+    it 'returns false when publishing fails and stores errors' do
+      fake_client = double
+      Client.stub(new: fake_client)
+      fake_client.
+        should_receive(:post_notification).with do |args|
+          args[:message].should be_nil
+        end.
+        and_return([{ errors: { attributes: { message: ['is not present'] }}}, Keikokuc::Client::InvalidNotification])
+
+      notification = build(:notification, message: nil)
+
+      result = notification.publish
+      result.should be_false
+
+      notification.remote_id.should be_nil
+      notification.errors[:attributes][:message].should == ['is not present']
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,22 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+require 'keikokuc'
+require './spec/factories'
+require './spec/support/fake_keikoku'
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+
+  config.include FactoryGirl::Syntax::Methods
+end

data/spec/support/fake_keikoku.rb

@@ -0,0 +1,75 @@
+class FakeKeikoku
+  def initialize
+    @publishers = []
+    @notifications = []
+  end
+
+  def register_publisher(opts)
+    @publishers << opts
+  end
+
+  def publisher_by_api_key(api_key)
+    @publishers.detect { |p| p[:api_key] == api_key }
+  end
+
+  def call(env)
+    with_rack_env(env) do
+      if request_path == '/api/v1/notifications' && request_verb == 'POST'
+        if publisher_by_api_key(request_api_key)
+          notification = Notification.new({id: next_id}.merge(request_body))
+          @notifications << notification
+          [200, { }, [Yajl::Encoder.encode({id: notification.id})]]
+        else
+          [401, { }, ["Not authorized"]]
+        end
+      end
+    end
+  end
+
+private
+  def rack_env
+    @rack_env
+  end
+
+  def with_rack_env(rack_env)
+    @rack_env = rack_env
+    response = yield
+  ensure
+    @rack_env = nil
+    response
+  end
+
+  def request_path
+    rack_env['PATH_INFO']
+  end
+
+  def request_verb
+    rack_env['REQUEST_METHOD']
+  end
+
+  def request_body
+    raw_body = rack_env["rack.input"].read
+    rack_env["rack.input"].rewind
+    Yajl::Parser.parse(raw_body)
+  end
+
+  def request_api_key
+    rack_env["HTTP_X_KEIKOKU_AUTH"]
+  end
+
+  def next_id
+    @@sequence ||= 0
+    @@sequence += 1
+  end
+
+  class Notification
+    def initialize(opts)
+      @opts = opts
+      opts.each do |key, value|
+        self.class.send :define_method, key do
+          value
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: keikokuc
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Harold Giménez
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: &70304962398080 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70304962398080
+- !ruby/object:Gem::Dependency
+  name: yajl-ruby
+  requirement: &70304962397660 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70304962397660
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70304962397240 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70304962397240
+- !ruby/object:Gem::Dependency
+  name: factory_girl
+  requirement: &70304962396820 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70304962396820
+- !ruby/object:Gem::Dependency
+  name: sham_rack
+  requirement: &70304962396400 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70304962396400
+description: Keikoku API client
+email:
+- harold.gimenez@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- keikokuc.gemspec
+- lib/handles_timeout.rb
+- lib/keikokuc.rb
+- lib/keikokuc/client.rb
+- lib/keikokuc/notification.rb
+- lib/keikokuc/version.rb
+- spec/factories.rb
+- spec/keikoku/client_spec.rb
+- spec/keikoku/notification_spec.rb
+- spec/spec_helper.rb
+- spec/support/fake_keikoku.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Keikoku API client
+test_files:
+- spec/factories.rb
+- spec/keikoku/client_spec.rb
+- spec/keikoku/notification_spec.rb
+- spec/spec_helper.rb
+- spec/support/fake_keikoku.rb