firebell 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: faa637876d0bf50ce95d1ea11cb717f9195bc82e
+  data.tar.gz: af8d7b4ac2abc4849e4f3544c3e77e0f2cd748d7
+SHA512:
+  metadata.gz: 33af9bf718a733c273a66b8a74d57c9ae57f36156e222b501efa351f2125014fde10dc6248ed982a7656fbd2fc9fe2eaf280ebeaf3218074387c8d06a3da2fdb
+  data.tar.gz: 5f95e73ebe38245ce287567ab3034bb71f1ea4075323aba90be2fa857ac2b5e3d62109e2d76db980a23779d3333b07ac97f491086154471b88c44b07d64cda21

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 @@
+--color

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Luke Carpenter
+
+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,41 @@
+# Firebell
+
+Firebell notifier for Ruby
+
+## Usage
+
+```ruby
+firebell = Firebell::Client.new
+
+# creating events
+
+# with just a tag
+firebell.notify "project.category.event"
+
+# with a body
+firebell.notify "project.category.event", "category has event"
+
+# with parameters
+firebell.notify "project.category.event", "location" => "http://server/file"
+
+# with both
+firebell.notify "project.category.event", "location" => "http://server/file", "category has event"
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'firebell'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install firebell
+
+## Contributing
+
+PR via [Github](https://github.com/ghostworks/firebell), suggestions to luke@ghostworks.io

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/env.rb

@@ -0,0 +1,3 @@
+$:.unshift File.expand_path(File.dirname(__FILE__) + "/lib")
+
+require "firebell"

data/firebell.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'firebell/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "firebell"
+  spec.version       = Firebell::VERSION
+  spec.authors       = ["Luke Carpenter"]
+  spec.email         = ["x@rubynerd.net"]
+  spec.summary       = %q{Push notifications as a service}
+  spec.description   = %q{A ruby client for Firebell, push notifications as a service}
+  spec.homepage      = "https://github.com/ghostworks/firebell"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "mocha"
+end

data/lib/firebell/client.rb

@@ -0,0 +1,40 @@
+require "net/http"
+
+class Firebell::Client
+  attr_accessor :token
+
+  def initialize(token = Firebell.configuration.token)
+    @token = token
+  end
+
+  def notify(tag, body_or_params = nil, body = nil)
+    if body_or_params
+      if body_or_params.is_a?(Hash)
+        attributes = { "tag" => tag, "parameters" => body_or_params }
+        attributes.merge!("body" => body) if body
+      else
+        attributes = { "tag" => tag, "body" => body_or_params }
+      end
+    else
+      attributes = { "tag" => tag }
+    end
+
+    send_request attributes
+  end
+
+  private
+  def send_request(attrs)
+    request = Net::HTTP::Post.new uri.request_uri, "Authorization" => "Token #{@token}"
+    request.set_form_data attrs
+
+    http.request(request)
+  end
+
+  def http
+    @http ||= Net::HTTP.new uri.host, uri.port
+  end
+
+  def uri
+    @uri ||= URI.parse Firebell.configuration.url
+  end
+end

data/lib/firebell/version.rb

@@ -0,0 +1,3 @@
+module Firebell
+  VERSION = "0.1.0"
+end

data/lib/firebell.rb

@@ -0,0 +1,32 @@
+require "firebell/version"
+
+module Firebell
+  def self.configure
+    yield configuration
+    configuration
+  end
+
+  def self.configuration
+    @@configuration ||= Configuration.new
+  end
+
+  class Configuration
+    attr_writer :host, :url
+    attr_accessor :token
+
+    def host
+      @host ||= "https://firebellapp.com"
+    end
+
+    def path
+      @path ||= "/api/v1/events"
+    end
+
+    def url
+      @url ||= "#{host}#{path}"
+    end
+
+  end
+end
+
+require "firebell/client"

data/spec/firebell/client_spec.rb

@@ -0,0 +1,51 @@
+require "spec_helper"
+
+describe Firebell::Client do
+  let(:client) { Firebell::Client.new "token" }
+
+  describe "#uri" do
+    it "is HTTPS by default" do
+      expect(client.send(:uri)).to be_instance_of URI::HTTPS
+    end
+
+    it "is a URI object of the configured URL" do
+      expect(client.send(:uri)).to eq URI.parse Firebell.configuration.url
+    end
+  end
+
+
+  context "with a tag and body" do
+    it "makes a request" do
+      Firebell::Client.any_instance.expects(:send_request).with("tag" => "test.subject", "body" => "hello")
+      client.notify "test.subject", "hello"
+    end
+  end
+
+  context "with a tag and parameters" do
+    it "makes a request" do
+      Firebell::Client.any_instance.expects(:send_request)
+        .with("tag" => "test.subject", "parameters" => { "p1" => 1 })
+
+      client.notify "test.subject", "p1" => 1
+    end
+  end
+
+  context "with a tag, parameters, and body" do
+    it "makes a request" do
+      Firebell::Client.any_instance.expects(:send_request)
+        .with("tag" => "test.subject", "parameters" => { "p1" => 1 }, "body" => "hello")
+
+      client.notify "test.subject", { "p1" => 1 }, "hello"
+    end
+  end
+
+  context "with just a tag" do
+    it "makes a request" do
+      Firebell::Client.any_instance.expects(:send_request)
+        .with("tag" => "test.subject")
+
+      client.notify "test.subject"
+    end
+  end
+
+end

data/spec/firebell/configuration_spec.rb

@@ -0,0 +1,25 @@
+require "spec_helper"
+
+describe Firebell::Configuration do
+  it "automatically sets a hostname" do
+    c = Firebell::Configuration.new
+    expect(c.host).to eq "https://firebellapp.com"
+  end
+
+  it "automatically sets a path" do
+    c = Firebell::Configuration.new
+    expect(c.path).to eq "/api/v1/events"
+  end
+
+  it "generates an events URL" do
+    c = Firebell::Configuration.new
+    expect(c.url).to eq "https://firebellapp.com/api/v1/events"
+  end
+
+  it "accepts a non-standard hostname" do
+    c = Firebell::Configuration.new
+    c.host = "http://cowbell.dev"
+    expect(c.url).to eq "http://cowbell.dev/api/v1/events"
+
+  end
+end

data/spec/firebell_spec.rb

@@ -0,0 +1,11 @@
+require "spec_helper"
+
+describe Firebell do
+  describe "::configure" do
+    it "returns a Configuration object to ::configuration" do
+      configuration = Firebell.configure {}
+      expect(configuration).to be_instance_of Firebell::Configuration
+      expect(configuration).to eq Firebell.configuration
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+require 'bundler/setup'
+Bundler.setup
+
+require 'firebell'
+
+RSpec.configure do |c|
+  c.mock_with :mocha
+
+  c.after(:each) do
+    Firebell.remove_class_variable :@@configuration if Firebell.class_variable_defined? :@@configuration
+  end
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: firebell
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Luke Carpenter
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A ruby client for Firebell, push notifications as a service
+email:
+- x@rubynerd.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- env.rb
+- firebell.gemspec
+- lib/firebell.rb
+- lib/firebell/client.rb
+- lib/firebell/version.rb
+- spec/firebell/client_spec.rb
+- spec/firebell/configuration_spec.rb
+- spec/firebell_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/ghostworks/firebell
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Push notifications as a service
+test_files:
+- spec/firebell/client_spec.rb
+- spec/firebell/configuration_spec.rb
+- spec/firebell_spec.rb
+- spec/spec_helper.rb