campy 0.1.0

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 1.9.2
+  - rbx-19mode
+  - 1.8.7
+  - ree
+  - rbx-18mode
+  - jruby-18mode
+  - ruby-head
+  - jruby-head

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## 0.1.0 (April 4, 2012)
+
+The initial release.
+
+[@fnichol]: https://github.com/fnichol

data/Gemfile

@@ -0,0 +1,16 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in campy.gemspec
+gemspec
+
+group :test do
+  gem 'rake', '~> 0.9'
+
+  gem 'growl'
+  gem 'guard'
+  gem 'guard-minitest'
+end
+
+platforms :jruby do
+  gem 'jruby-openssl'
+end

data/Guardfile

@@ -0,0 +1,5 @@
+guard 'minitest' do
+  # with Minitest::Spec
+  watch(%r|^spec/(.*)_spec\.rb|)
+  watch(%r|^lib/(.*)([^/]+)\.rb|)     { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
+end

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Fletcher Nichol
+
+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,99 @@
+# <a name="title"></a> Campy [![Build Status](https://secure.travis-ci.org/fnichol/campy.png)](http://travis-ci.org/fnichol/campy)
+
+Tiny Campfire client so you can get on with it. It's implemented on top of
+`Net::HTTP` and only requires the `multi_json` gem for Ruby compatibilities.
+
+## <a name="installation"></a> Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'campy'
+```
+
+And then execute:
+
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+
+```
+$ gem install campy
+```
+
+## <a name="usage"></a> Usage
+
+First create a `campfire.yml` file in your home directory:
+
+```bash
+$ cat <<CAMPFIRE_YAML > $HOME/.campfire.yml
+:account: mysubdomain
+:token: mytoken123
+:room: House of Hubot
+CAMPFIRE_YAML
+```
+
+### <a name="usage-bin"></a> campy Command
+
+Campy comes with the `campy` command so you can send messages from the
+command line:
+
+```bash
+$ campy speak "Campy says yello"
+$ campy play ohmy
+```
+
+### <a name="usage-ruby"></a> Ruby Library
+
+There's not much to the API; create a `Campy::Room` and go:
+
+```ruby
+require 'campy'
+
+campy = Campy::Room.new(:account => "mysubdomain", :token => "mytoken123",
+  :room => "House of Hubot")
+campy.speak "Campy says yello"
+campy.play "ohmy"
+```
+
+Why not use the `campfire.yml` config? Let's do that:
+
+```ruby
+require 'campy'
+require 'yaml'
+
+campy = Campy::Room.new(YAML.load_file(File.expand_path("~/.campfire.yml")))
+campy.speak "Campy says yello"
+campy.play "ohmy"
+```
+
+## <a name="development"></a> Development
+
+* Source hosted at [GitHub][repo]
+* Report issues/questions/feature requests on [GitHub Issues][issues]
+
+Pull requests are very welcome! Make sure your patches are well tested.
+Ideally create a topic branch for every separate change you make. For
+example:
+
+1. Fork the repo
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## <a name="authors"></a> Authors
+
+Created and maintained by [Fletcher Nichol][fnichol] (<fnichol@nichol.ca>)
+
+## <a name="license"></a> License
+
+MIT (see [LICENSE][license])
+
+[license]:      https://github.com/fnichol/campy/blob/master/LICENSE
+[fnichol]:      https://github.com/fnichol
+[repo]:         https://github.com/fnichol/campy
+[issues]:       https://github.com/fnichol/campy/issues
+[contributors]: https://github.com/fnichol/campy/contributors

data/Rakefile

@@ -0,0 +1,12 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs.push "lib"
+  t.test_files = FileList['spec/**/*_spec.rb']
+  t.verbose = true
+end
+
+task :default => 'test'

data/bin/campy

@@ -0,0 +1,38 @@
+#!/usr/bin/env ruby
+
+$:.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+require 'campy'
+require 'yaml'
+
+def options
+  yaml_file = File.expand_path(ENV['CAMPFIRE_YAML_FILE'] || '~/.campfire.yml')
+  if !File.exists?(yaml_file)
+    abort "File '#{yaml_file}' does not exist with campfire configuration."
+  end
+  YAML.load_file(yaml_file)
+end
+
+def usage
+  <<-USAGE.gsub(/^ {4}/, '')
+
+    Usage
+
+      campy <action> <message>
+
+    Actions
+
+      help  - Display CLI help (this output)
+      speak - Speak a message into the campfire room
+      play  - Play a sound into the campfire room
+
+  USAGE
+end
+
+if ARGV.first == "help"
+  puts usage
+  exit
+end
+
+abort usage if ARGV.empty? || !%w{speak play}.include?(ARGV.first)
+
+Campy::Room.new(options).send(ARGV.shift, ARGV.shift)

data/campy.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/campy/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Fletcher Nichol"]
+  gem.email         = ["fnichol@nichol.ca"]
+  gem.description   = %q{Small Campfire client using Net::HTTP.}
+  gem.summary       = gem.description
+  gem.homepage      = "http://fnichol.github.com/campy/"
+
+  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          = "campy"
+  gem.require_paths = ["lib"]
+  gem.version       = Campy::VERSION
+
+  gem.add_dependency "multi_json", "~> 1.0"
+
+  gem.add_development_dependency "minitest", "~> 2.12.0"
+  gem.add_development_dependency "webmock", "~> 1.8.5"
+end

data/lib/campy.rb

@@ -0,0 +1,6 @@
+require 'campy/version'
+require 'campy/room'
+
+module Campy
+  # Your code goes here...
+end

data/lib/campy/room.rb

@@ -0,0 +1,186 @@
+# -*- encoding: utf-8 -*-
+require 'net/https'
+require 'multi_json'
+
+module Campy
+  class Room
+    # Public: Error class raised when a room ID cannot be found with a
+    # given name.
+    class NotFound < RuntimeError ; end
+
+    # Public: Error class raised when an HTTP error has occured.
+    class ConnectionError < RuntimeError ; end
+
+    # Public: Returns the String account name.
+    attr_reader :account
+
+    # Public: Returns the String room name.
+    attr_reader :room
+
+    # Public: Returns the API token String for a user.
+    attr_reader :ssl
+
+    # Public: Initializes a Room from a Hash of configuration options.
+    #
+    # options - A Hash of options to set up the Room (default: {}):
+    #           :account  - The String account/subdomain name.
+    #           :room     - The String room name, not the room ID.
+    #           :token    - The API token String for a user.
+    #           :ssl      - A truthy object which is true when SSL is
+    #                       required (default: true).
+    def initialize(options = {})
+      options = { :ssl => true }.merge(options)
+
+      [:account, :room, :token, :ssl].each do |option|
+        instance_variable_set "@#{option}", options[option]
+      end
+    end
+
+    # Public: Returns the Integer room ID of the Campfire room.
+    #
+    # Returns the Integer room ID.
+    # Raises NotFound if a room cannot be found for the given name.
+    # Raises ConnectionError if an HTTP error occurs.
+    def room_id
+      @room_id ||= fetch_room_id
+    end
+
+    # Public: Posts a message into the campfire room.
+    #
+    # msg - A String message.
+    #
+    # Returns true if message is delivered.
+    # Raises ConnectionError if an HTTP error occurs.
+    def speak(msg)
+      send_message(msg)
+    end
+
+    # Public: Plays a sound into the campfire room.
+    #
+    # sound - A String representing the sound.
+    #
+    # Returns true if message is delivered.
+    # Raises ConnectionError if an HTTP error occurs.
+    def play(msg)
+      send_message(msg, 'SoundMessage')
+    end
+
+    private
+
+    # Internal: Array of errors that will be wrapped when using Net::HTTP.
+    HTTP_ERRORS = [Timeout::Error, Errno::EINVAL, Errno::ECONNRESET,
+      EOFError, Net::HTTPBadResponse, Net::HTTPHeaderSyntaxError,
+      Net::ProtocolError, SocketError, OpenSSL::SSL::SSLError,
+      Errno::ECONNREFUSED]
+
+    # Internal: Returns the API token String for a user.
+    attr_reader :token
+
+    # Internal: Returns the campfire hostname with subdomain.
+    def host
+      "#{account}.campfirenow.com"
+    end
+
+    # Internal: Returns the Integer HTTP port number to connect with.
+    def port
+      ssl ? 443 : 80
+    end
+
+    # Internal: Returns the Integer number of the room.
+    #
+    # Returns the Integer room number.
+    # Raises NotFound if a room cannot be found for the given name.
+    # Raises ConnectionError if an HTTP error occurs.
+    def fetch_room_id
+      connect do |http|
+        response = http.request(http_request(:get, "/rooms.json"))
+
+        case response
+        when Net::HTTPOK
+          find_room_in_json(MultiJson.decode(response.body))
+        else
+          raise ConnectionError
+        end
+      end
+    end
+
+    # Internal: Posts a message to the campfire room.
+    #
+    # msg   - The String message to send.
+    # type  - The String type of campfire message (default: TextMessage).
+    #
+    # Returns true if message is delivered.
+    # Raises ConnectionError if an HTTP error occurs.
+    def send_message(msg, type = 'TextMessage')
+      connect do |http|
+        request = http_request(:post, "/room/#{room_id}/speak.json")
+        request.body = MultiJson.encode(
+          { :message => { :body => msg, :type => type } })
+        response = http.request(request)
+
+        case response
+        when Net::HTTPCreated
+          true
+        else
+          raise ConnectionError,
+            "Error sending message '#{msg}' (#{response.class})"
+        end
+      end
+    end
+
+    # Internal: Parses through the rooms JSON response and returns the
+    # Integer room ID.
+    #
+    # json  - the rooms Hash of JSON data.
+    #
+    # Returns the Integer room number.
+    # Raises NotFound if a room cannot be found for the given name.
+    def find_room_in_json(json)
+      room_hash = json["rooms"].find { |r| r["name"] == room }
+
+      if room_hash
+        room_hash["id"]
+      else
+        raise NotFound, "Room name '#{room}' could not be found."
+      end
+    end
+
+    # Internal: Creates a Net::HTTP connection and yields to a block with
+    # the connection.
+    #
+    # Yields the Net::HTTP connection.
+    #
+    # Returns the return value (if any) of the block.
+    # Raises ConnectionError if any common HTTP errors are raised.
+    def connect
+      http = Net::HTTP.new(host, port)
+      http.use_ssl = ssl
+
+      begin
+        yield http
+      rescue *HTTP_ERRORS => exception
+        raise ConnectionError, "#{exception.class.name}: #{exception.message}"
+      end
+    end
+
+    # Internal: Returns a Net::HTTPRequest object initialized with
+    # authentication and content headers set.
+    #
+    # verb  - A Symbol representing an HTTP verb.
+    # path  - The String path of the request.
+    #
+    # Examples
+    #
+    #   http_request(:get, "/rooms.json")
+    #   http_request(:post, "/room/1/speak.json")
+    #
+    # Returns a Net::HTTPRequest object.
+    def http_request(verb, path)
+      klass = klass = Net::HTTP.const_get(verb.to_s.capitalize)
+      request = klass.new(path)
+      request.basic_auth(token, "X")
+      request["Content-Type"] = "application/json"
+      request
+    end
+  end
+end

data/lib/campy/version.rb

@@ -0,0 +1,4 @@
+# -*- encoding: utf-8 -*-
+module Campy
+  VERSION = "0.1.0"
+end

data/spec/campy/room_spec.rb

@@ -0,0 +1,166 @@
+# -*- encoding: utf-8 -*-
+require 'minitest/autorun'
+require 'webmock/minitest'
+require 'campy/room'
+
+describe Campy::Room do
+  WRAPPED_ERRORS = [Timeout::Error, Errno::EINVAL, Errno::ECONNRESET, EOFError,
+      Net::HTTPBadResponse, Net::HTTPHeaderSyntaxError, Net::ProtocolError,
+      SocketError, OpenSSL::SSL::SSLError, Errno::ECONNREFUSED]
+
+  let(:opts) do
+    { :account => 'zubzub', :token => 'yepyep',
+      :room => 'myroom', :ssl => true }
+  end
+
+  let(:stub_rooms!) do
+    stub_request(:get, "https://yepyep:X@zubzub.campfirenow.com/rooms.json").
+      with(:headers => {'Content-Type' => 'application/json'}).
+      to_return(:status => 200, :body => fixture("rooms"), :headers => {})
+  end
+
+  let(:stub_rooms_no_room!) do
+    stub_request(:get, "https://yepyep:X@zubzub.campfirenow.com/rooms.json").
+      with(:headers => {'Content-Type' => 'application/json'}).
+      to_return(:status => 200, :body => fixture("no_rooms"), :headers => {})
+  end
+
+  let(:stub_rooms_invalid_token!) do
+    stub_request(:get, "https://yepyep:X@zubzub.campfirenow.com/rooms.json").
+      with(:headers => {'Content-Type' => 'application/json'}).
+      to_return(:status => 401, :body => "HTTP Basic: Access denied.\n",
+                :headers => {})
+  end
+
+  def stub_rooms_error!(error)
+    stub_request(:get, "https://yepyep:X@zubzub.campfirenow.com/rooms.json").
+      with(:headers => {'Content-Type' => 'application/json'}).
+      to_raise(error)
+  end
+
+  def stub_speak!(msg, type = 'TextMessage')
+    stub_request(:post, "https://yepyep:X@zubzub.campfirenow.com/room/123456/speak.json").
+      with(:headers => {'Content-Type' => 'application/json'},
+           :body => {:message => {:body => msg, :type => type}}).
+      to_return(:status => 201, :headers => {},
+                :body => fixture("speak").sub(/@@MESSAGE@@/, msg))
+  end
+
+  def stub_speak_error!(error)
+    stub_request(:post, "https://yepyep:X@zubzub.campfirenow.com/room/123456/speak.json").
+      with(:headers => {'Content-Type' => 'application/json'}).
+      to_raise(error)
+  end
+
+  def fixture(name)
+    File.read(File.dirname(__FILE__) + "/../fixtures/webmock_#{name}.txt")
+  end
+
+  describe "#initialize" do
+    it "takes a hash of campfire configuration" do
+      room = Campy::Room.new(opts)
+      room.account.must_equal 'zubzub'
+      room.room.must_equal    'myroom'
+    end
+
+    it "defaults to SSL mode enabled" do
+      opts.delete(:ssl)
+      room = Campy::Room.new(opts)
+      room.ssl.must_equal true
+    end
+  end
+
+  describe "#room_id" do
+    let(:subject) { Campy::Room.new(opts) }
+
+    it "fetches the room id from the API" do
+      stub_rooms!
+      subject.room_id.must_equal 666666
+    end
+
+    it "raises NotFound if no room is found" do
+      stub_rooms_no_room!
+
+      proc { subject.room_id }.must_raise(
+        Campy::Room::NotFound)
+    end
+
+    it "raises ConnectionError if the token is invalid" do
+      stub_rooms_invalid_token!
+
+      proc { subject.room_id }.must_raise(
+        Campy::Room::ConnectionError)
+    end
+
+    WRAPPED_ERRORS.each do |error|
+      it "wraps #{error} and raises a ConnectionError" do
+        stub_rooms_error!(error)
+
+        proc { subject.room_id }.must_raise(
+          Campy::Room::ConnectionError)
+      end
+    end
+  end
+
+  describe "#speak" do
+    let(:subject) { Campy::Room.new(opts) }
+
+    before do
+      # stub out #room_id since we don't care about this API call
+      def subject.room_id ; 123456 ; end
+    end
+
+    it "calls the speak API with a message" do
+      stub = stub_speak!("talking about talking")
+      subject.speak "talking about talking"
+
+      assert_requested(stub)
+    end
+
+    it "returns true when message is delivered" do
+      stub = stub_speak!("talking about talking")
+
+      subject.speak("talking about talking").must_equal true
+    end
+
+    WRAPPED_ERRORS.each do |error|
+      it "wraps #{error} and raises a ConnectionError" do
+        stub_speak_error!(error)
+
+        proc { subject.speak "nope" }.must_raise(
+          Campy::Room::ConnectionError)
+      end
+    end
+  end
+
+  describe "#play" do
+    let(:subject) { Campy::Room.new(opts) }
+
+    before do
+      # stub out #room_id since we don't care about this API call
+      def subject.room_id ; 123456 ; end
+    end
+
+    it "calls the play API with a sound" do
+      stub = stub_speak!("tada", "SoundMessage")
+      subject.play "tada"
+
+      assert_requested(stub)
+    end
+
+    it "returns true when message is delivered" do
+      stub = stub_speak!("tada", "SoundMessage")
+
+      subject.play("tada").must_equal true
+    end
+
+    WRAPPED_ERRORS.each do |error|
+      it "wraps #{error} and raises a ConnectionError" do
+        stub_speak_error!(error)
+
+        proc { subject.play "tada" }.must_raise(
+          Campy::Room::ConnectionError)
+      end
+    end
+  end
+end

data/spec/fixtures/webmock_no_rooms.txt

@@ -0,0 +1,4 @@
+{
+  "rooms": [
+  ]
+}

data/spec/fixtures/webmock_rooms.txt

@@ -0,0 +1,22 @@
+{
+  "rooms": [
+    {
+      "created_at": "2012/01/01 00:01:02 +0000",
+      "id": 123456,
+      "locked": false,
+      "membership_limit": 4,
+      "name": "nuggettalk",
+      "topic": "Pop go the nuggets",
+      "updated_at": "2012/02/23 02:21:49 +0000"
+    },
+    {
+      "created_at": "2011/01/01 00:02:03 +0000",
+      "id": 666666,
+      "locked": false,
+      "membership_limit": 12,
+      "name": "myroom",
+      "topic": "There is only one test",
+      "updated_at": "2011/12/05 16:23:40 +0000"
+    }
+  ]
+}

data/spec/fixtures/webmock_speak.txt

@@ -0,0 +1,11 @@
+{
+  "message": {
+    "body": "@@MESSAGE@@",
+    "created_at": "2012/04/04 18:11:36 +0000",
+    "id": 999999999,
+    "room_id": 123456,
+    "starred": false,
+    "type": "TextMessage",
+    "user_id": 666
+  }
+}

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: campy
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Fletcher Nichol
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: &70347351272720 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70347351272720
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: &70347351272200 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.12.0
+  type: :development
+  prerelease: false
+  version_requirements: *70347351272200
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: &70347351271740 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.5
+  type: :development
+  prerelease: false
+  version_requirements: *70347351271740
+description: Small Campfire client using Net::HTTP.
+email:
+- fnichol@nichol.ca
+executables:
+- campy
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- CHANGELOG.md
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/campy
+- campy.gemspec
+- lib/campy.rb
+- lib/campy/room.rb
+- lib/campy/version.rb
+- spec/campy/room_spec.rb
+- spec/fixtures/webmock_no_rooms.txt
+- spec/fixtures/webmock_rooms.txt
+- spec/fixtures/webmock_speak.txt
+homepage: http://fnichol.github.com/campy/
+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'
+      segments:
+      - 0
+      hash: 1286988910110324181
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 1286988910110324181
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.17
+signing_key: 
+specification_version: 3
+summary: Small Campfire client using Net::HTTP.
+test_files:
+- spec/campy/room_spec.rb
+- spec/fixtures/webmock_no_rooms.txt
+- spec/fixtures/webmock_rooms.txt
+- spec/fixtures/webmock_speak.txt