growl_car 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7141fc307f5039f7db2c7938af4c2f9c1806170f
+  data.tar.gz: c55b24d953b7f528ce4d588476c1cceb66a10884
+SHA512:
+  metadata.gz: 3da53d7b279e37e665658c56640e7b892a20a8b188536912e259f422e5511d40ce3f8ac38c1fa56fe08b5d45687adba56f687c737519d35df45507233244c217
+  data.tar.gz: ba498a8e629d748901845d68036692e41ebf2bd5c11e8728146820e2ff777577f70170b8b52780c0a89edd0ba89a028ab516c977fcc57ebfe0b71fb760a03594

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/.travis.yml

@@ -0,0 +1,33 @@
+language: ruby
+rvm:
+  - jruby-19mode
+  - rbx-19mode
+  - 1.9.3
+  - 2.0.0
+  - ruby-head
+  - jruby-head
+jdk:
+  - openjdk6
+  - openjdk7
+  - oraclejdk7
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: jruby-head
+  exclude:
+    - rvm: 1.9.3
+      jdk: openjdk7
+    - rvm: 1.9.3
+      jdk: oraclejdk7
+    - rvm: 2.0.0
+      jdk: openjdk7
+    - rvm: 2.0.0
+      jdk: oraclejdk7
+    - rvm: ruby-head
+      jdk: openjdk7
+    - rvm: ruby-head
+      jdk: oraclejdk7
+    - rvm: rbx-19mode
+      jdk: openjdk7
+    - rvm: rbx-19mode
+      jdk: oraclejdk7

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## v0.0.1
+
+* Initial release

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Matthew Shafer
+
+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,77 @@
+# GrowlCar
+[![Build Status](https://travis-ci.org/matthewshafer/growl_car.png?branch=master)](https://travis-ci.org/matthewshafer/growl_car)
+[![Dependency Status](https://gemnasium.com/matthewshafer/growl_car.png)](https://gemnasium.com/matthewshafer/growl_car)
+[![Code Climate](https://codeclimate.com/github/matthewshafer/growl_car.png)](https://codeclimate.com/github/matthewshafer/growl_car)
+[![Coverage Status](https://coveralls.io/repos/matthewshafer/growl_car/badge.png?branch=master)](https://coveralls.io/r/matthewshafer/growl_car)
+
+Sending notifications to the growl provider on boxcar.io
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'growl_car'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install growl_car
+
+## Usage
+
+You will need to enable the Growl provider on your boxcar account.
+
+### Sample Usage
+
+```ruby
+require 'growl_car'
+
+GrowlCar.configure do |config|
+  config.username = "YOUR_BOXCAR_USERNAME"
+  config.password = "YOUR_BOXCAR_PASSWORD"
+end
+
+GrowlCar.send_growl_notification("GrowlCar-test", "This message is from GrowlCar")
+```
+
+It is also possible to instantiate a ``` GrowlCar::Client ``` to handle multiple users:
+
+```ruby
+matt = GrowlCar::Client.new(username: MATT_BOXCAR_USERNAME, password: MATT_BOXCAR_PASSWORD)
+
+alex = GrowlCar::Client.new(username: ALEX_BOXCAR_USERNAME, password: ALEX_BOXCAR_PASSWORD)
+
+matt.send_growl_notification("GrowlCar-matt", "Hey how's it going?")
+
+alex.send_growl_notification("GrowlCar-alex", "The Food is ready")
+```
+
+### Errors
+
+the ``` send_growl_notification ``` method can raise errors if it encounters any issues with boxcar.
+If is unable to log in (unauthorized response) it will raise a ``` GrowlCar::Error::UnauthorizedError ```
+For any response that is not a 200 or 401 (unauthorized) it will raise a ``` GrowlCar::Error::HttpError ```
+
+## Documentation
+
+You can find the latest documentation of the master branch here: http://rubydoc.info/github/matthewshafer/growl_car/
+
+## Contributing
+
+### Issues
+
+Issues can be reported right here on the github repo.
+Everyone is encouraged to write an issue if they find a bug or have a request.
+
+### Pull Requests
+
+Everyone can also submit pull requests.  Here are some guidelines:
+
+1. Fork the repo
+2. Create a branch (make the name descriptive)
+3. Write tests and work on your changes
+4. Make sure all tests pass and your code is covered
+5. Open a pull request and write a description of what you did

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/growl_car.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'growl_car/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "growl_car"
+  spec.version       = GrowlCar::VERSION
+  spec.authors       = ["Matthew Shafer"]
+  spec.email         = ["matthewshafer@mac.com"]
+  spec.description   = %q{Sending growl notifications to boxcar.io}
+  spec.summary       = %q{A tool to allow sending notifications to the growl provider on boxcar.io}
+  spec.homepage      = "https://github.com/matthewshafer/growl_car"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 2.13.0"
+  spec.add_development_dependency "webmock", "~> 1.11.0"
+  spec.add_development_dependency "simplecov", "~> 0.7.1"
+  spec.add_development_dependency "coveralls", "~> 0.6.4"
+
+  spec.add_dependency "atomic", "~> 1.1.0"
+  spec.add_dependency "httpclient", "~> 2.3.3"
+end

data/lib/growl_car.rb

@@ -0,0 +1,38 @@
+require "growl_car/version"
+require "growl_car/configuration"
+require "growl_car/client"
+require "growl_car/error"
+require 'atomic'
+
+module GrowlCar
+
+  @client = ::Atomic.new
+
+  class << self
+    include Configuration
+
+    def client
+      create_client unless @client.value
+      @client.value
+    end
+
+    def respond_to?(method)
+      return client.respond_to?(method)
+    end
+
+    private
+
+      def method_missing(method_name, *args, &block)
+        return super unless client.respond_to?(method_name)
+        client.send(method_name, *args, &block)
+      end
+
+      def create_client
+        begin
+          @client.try_update { GrowlCar::Client.new(credentials) }
+        rescue Atomic::ConcurrentUpdateError
+
+        end
+      end
+  end
+end

data/lib/growl_car/client.rb

@@ -0,0 +1,26 @@
+require "growl_car/configuration"
+require "growl_car/request"
+require "growl_car/growl_notification"
+
+module GrowlCar
+  class Client
+    include GrowlCar::Request
+    include GrowlCar::GrowlNotification
+
+    # Initialize a new GrowlCar::Client
+    #
+    # @param options [Hash]
+    # @return [GrowlCar::Client]
+    def initialize(options={})
+      GrowlCar::Configuration.keys.each do |key|
+        instance_variable_set(:"@#{key}", options[key])
+      end
+
+      super()
+
+      set_auth(@username, @password)
+    end
+
+    
+  end
+end

data/lib/growl_car/configuration.rb

@@ -0,0 +1,58 @@
+module GrowlCar
+  module Configuration
+    attr_writer :username, :password
+
+    class << self
+
+      # List of keys used for configuration
+      #
+      # @return [Array]
+      def keys
+        @keys ||= [
+          :username,
+          :password
+        ]
+      end
+
+      # Url for boxcar.io
+      #
+      # @return [String]
+      def boxcar_url
+        "https://boxcar.io/notifications"
+      end
+    end
+
+    # Convenience method to allow GrowlCar configuration to be set in a block
+    #
+    # @raise [GrowlCar::Error::ConfigurationError] if credentials are not in the form of a string
+    def configure
+      yield self
+      validate_credentials!
+      self
+    end
+
+    # Set all configuration values to nil
+    def reset!
+      GrowlCar::Configuration.keys.each do |key|
+        instance_variable_set(:"@#{key}", nil)
+      end
+    end
+
+    private
+
+      def credentials
+        {
+          :username => @username,
+          :password => @password
+        }
+      end
+
+      def validate_credentials!
+        credentials.each do |credential, value|
+          unless value.is_a?(String)
+            raise GrowlCar::Error::ConfigurationError, "Invalid #{credential}. Must be a string"
+          end
+        end
+      end
+  end
+end

data/lib/growl_car/error.rb

@@ -0,0 +1,7 @@
+module GrowlCar
+  module Error
+    ConfigurationError = Class.new(::StandardError)
+    UnauthorizedError = Class.new(::StandardError)
+    HttpError = Class.new(::StandardError)
+  end
+end

data/lib/growl_car/growl_notification.rb

@@ -0,0 +1,27 @@
+module GrowlCar
+  module GrowlNotification
+
+    # Sends a notification to the boxcar.io growl provider
+    # 
+    # @param from [String] name of the sender of the message
+    # @param message [String] message to be sent to boxcar
+    # @raise [GrowlCar::Error::UnauthorizedError] if username or password is incorrect
+    # @raise [GrowlCar::Error::HttpError] if http response is not 200 or 401
+    # @return [Boolean] on successful notification
+    def send_growl_notification(from, message)
+      boxcar_post_fields = {
+        "notification[from_screen_name]" => from,
+        "notification[message]" => message,
+        "notification[from_remote_service_id]" => random_growl_number
+      }
+
+      post_notification(boxcar_post_fields)
+    end
+
+    private
+
+      def random_growl_number
+        Random.rand(9999999999)
+      end
+  end
+end

data/lib/growl_car/request.rb

@@ -0,0 +1,32 @@
+require 'httpclient'
+
+module GrowlCar
+  module Request
+
+    # Initialize HTTPClient for requests
+    def initialize
+      @http = HTTPClient.new
+    end
+
+    private
+
+      def post_notification(query)
+        raise_if_status_not_ok(@http.post(GrowlCar::Configuration.boxcar_url, query).status)
+      end
+
+      def raise_if_status_not_ok(status)
+        case status
+        when 200
+          true
+        when 401
+          raise GrowlCar::Error::UnauthorizedError
+        else
+          raise GrowlCar::Error::HttpError
+        end
+      end
+
+      def set_auth(username, password)
+        @http.set_auth(GrowlCar::Configuration.boxcar_url, username, password)
+      end
+  end
+end

data/lib/growl_car/version.rb

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

data/spec/growl_car/configuration_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe GrowlCar::Configuration do
+  
+  context ".keys" do
+
+    it "returns an array of keys" do
+      expect(GrowlCar::Configuration.keys).to eql([:username, :password])
+    end
+  end
+
+  context ".boxcar_url" do
+
+    it "returns the boxcar url to post growl notifications to" do
+      expect(GrowlCar::Configuration.boxcar_url).to eql("https://boxcar.io/notifications")
+    end
+  end
+end

data/spec/growl_car/growl_notification_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe GrowlCar::Client do
+
+  context ".new" do
+
+    let(:client) { GrowlCar::Client.new }
+
+    describe "#send_growl_notification" do
+
+      it "returns true when the request status is 200" do
+        stub_post("/notifications").to_return(status: 200)
+        expect(client.send_growl_notification("test", "test")).to be_true
+      end
+
+      it "raises a GrowlCar::Error::UnauthorizedError when a username or password is incorrect" do
+        stub_post("/notifications").to_return(status: [401, "Unauthorized"])
+        expect { client.send_growl_notification("test", "test") }.to raise_error(GrowlCar::Error::UnauthorizedError)
+      end
+
+      it "raises a GrowlCar::Error::HttpError when a status other than 200 or 401 is encountered" do
+        stub_post("/notifications").to_return(status: [404, "Not Found"])
+        expect { client.send_growl_notification("test", "test") }.to raise_error(GrowlCar::Error::HttpError)
+      end
+    end
+  end
+end

data/spec/growl_car_spec.rb

@@ -0,0 +1,94 @@
+require 'spec_helper'
+
+describe GrowlCar do
+  
+  context "when delegating to a client" do
+
+    before do
+      GrowlCar::Client.any_instance.stub(:test).and_return("testing")
+    end
+
+    it "delegates to GrowlCar::Client" do
+      expect(GrowlCar.test).to eql("testing")
+    end
+
+    describe ".respond_to?" do
+
+      it "delegates to GrowlCar::Client" do
+        expect(GrowlCar.respond_to?(:test)).to be_true
+      end
+    end
+
+    describe ".client" do
+      it "returns a GrowlCar::Client" do
+        expect(GrowlCar.client).to be_kind_of(GrowlCar::Client)
+      end
+
+      it "does not create a new GrowlCar::Client when one is already created" do
+        client = GrowlCar.client
+        expect(GrowlCar.client).to eql(client)
+      end
+
+      it "rescues an Atomic::ConcurrentUpdateError and does nothing" do
+        atomic_exception = double("Atomic", value: nil).as_null_object
+        atomic_exception.stub(:try_update).and_raise(Atomic::ConcurrentUpdateError)
+        GrowlCar.instance_variable_set(:"@client", atomic_exception)
+        expect { GrowlCar.client }.not_to raise_error(Atomic::ConcurrentUpdateError)
+      end
+    end
+  end
+
+  describe ".configuration" do
+
+    context "when invalid configuration data is provided" do
+
+      it "raises a configuration error" do
+        expect {
+          GrowlCar.configure do |config|
+            config.username = 1234
+            config.password = "test_password"
+          end
+        }.to raise_error(GrowlCar::Error::ConfigurationError)
+      end
+    end
+
+    context "when valid configuration data is provided" do
+
+      before do
+        GrowlCar.configure do |config|
+          config.username = "test"
+          config.password = "pass"
+        end
+      end
+
+      it "sets the username" do
+        expect(GrowlCar.instance_variable_get(:"@username")).to eql("test")
+      end
+
+      it "sets the password" do
+        expect(GrowlCar.instance_variable_get(:"@password")).to eql("pass")
+      end
+    end
+  end
+
+  describe ".reset!" do
+
+    context "resets valid valid configuration details" do
+
+      before do
+        GrowlCar.configure do |config|
+          config.username = "test"
+          config.password = "pass"
+        end
+      end
+
+      it "sets the username to nil" do
+        expect { GrowlCar.reset! }.to change { GrowlCar.instance_variable_get(:"@username") }
+      end
+
+      it "sets the password to nil" do
+        expect { GrowlCar.reset! }.to change { GrowlCar.instance_variable_get(:"@password") }
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+require 'simplecov'
+require 'coveralls'
+
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  SimpleCov::Formatter::HTMLFormatter,
+  Coveralls::SimpleCov::Formatter
+]
+SimpleCov.start
+
+require 'growl_car'
+require 'rspec'
+require 'webmock/rspec'
+
+WebMock.disable_net_connect!(allow: 'coveralls.io')
+
+def stub_post(path)
+  stub_request(:post, "https://boxcar.io" + path)
+end

metadata

@@ -0,0 +1,180 @@
+--- !ruby/object:Gem::Specification
+name: growl_car
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Matthew Shafer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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: 2.13.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.13.0
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.11.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.11.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.1
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.4
+- !ruby/object:Gem::Dependency
+  name: atomic
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: httpclient
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.3.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.3.3
+description: Sending growl notifications to boxcar.io
+email:
+- matthewshafer@mac.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- growl_car.gemspec
+- lib/growl_car.rb
+- lib/growl_car/client.rb
+- lib/growl_car/configuration.rb
+- lib/growl_car/error.rb
+- lib/growl_car/growl_notification.rb
+- lib/growl_car/request.rb
+- lib/growl_car/version.rb
+- spec/growl_car/configuration_spec.rb
+- spec/growl_car/growl_notification_spec.rb
+- spec/growl_car_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/matthewshafer/growl_car
+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.0.0
+signing_key: 
+specification_version: 4
+summary: A tool to allow sending notifications to the growl provider on boxcar.io
+test_files:
+- spec/growl_car/configuration_spec.rb
+- spec/growl_car/growl_notification_spec.rb
+- spec/growl_car_spec.rb
+- spec/spec_helper.rb