matchstick 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,16 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+gem "rest-client", "~>1.6.1"
+
+group :development do
+  gem "cover_me", ">=0"
+  gem "shoulda", ">= 0"
+  gem "mocha",   ">= 0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.2"
+end

data/Gemfile.lock

@@ -0,0 +1,33 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    configatron (2.6.4)
+      yamler (>= 0.1.0)
+    cover_me (1.0.0.rc4)
+      configatron
+      hashie
+    git (1.2.5)
+    hashie (0.4.0)
+    jeweler (1.5.2)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    mime-types (1.16)
+    mocha (0.9.10)
+      rake
+    rake (0.8.7)
+    rest-client (1.6.1)
+      mime-types (>= 1.16)
+    shoulda (2.11.3)
+    yamler (0.1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  cover_me
+  jeweler (~> 1.5.2)
+  mocha
+  rest-client (~> 1.6.1)
+  shoulda

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Kyle Daigle
+
+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.rdoc

@@ -0,0 +1,19 @@
+= matchstick
+
+This is the beginnings of a stable framework for communicating with Campfire. Currently, completely and utterly alpha.
+
+== Contributing to matchstick
+
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 Kyle Daigle. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,61 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "matchstick"
+  gem.homepage = "http://github.com/kdaigle/matchstick"
+  gem.license = "MIT"
+  gem.summary = %Q{A simple framework for communicating with 37signals' Campfire API.}
+  gem.description = %Q{A simple framework for communicating with 37signals' Campfire API. Currently still a work in progress.}
+  gem.email = "kyle@digitalworkbox.com"
+  gem.authors = ["Kyle Daigle"]
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  gem.add_runtime_dependency 'rest-client', '~>1.6.1'
+  #  gem.add_development_dependency 'rspec', '> 1.2.3'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+require 'cover_me'
+namespace :cover_me do
+
+  desc "Run the cover_me rport"
+  task :report do
+    require 'cover_me'
+    CoverMe.complete!
+  end
+
+end
+
+task :test do
+  Rake::Task['cover_me:report'].invoke
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "matchstick #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/matchstick.rb

@@ -0,0 +1,9 @@
+require 'rest_client'
+require 'json'
+
+require 'matchstick/campfire'
+require 'matchstick/room'
+
+module Matchstick
+  class Error < StandardError; end
+end

data/lib/matchstick/campfire.rb

@@ -0,0 +1,43 @@
+module Matchstick
+
+  class Campfire
+    HOST = "campfirenow.com"
+
+    attr_reader :subdomain, :api_key, :use_ssl, :connection
+
+    def initialize(subdomain, api_key, use_ssl=false)
+      @subdomain  = subdomain
+      @api_key    = api_key
+      @use_ssl    = use_ssl
+      @connection = build_connection
+
+      self
+    end
+
+    def rooms
+      get("rooms")["rooms"].collect {|room| Room.new(room, connection)}
+    end
+
+    def get(action)
+      response = RestClient.get "#{connection}/#{action}", :content_type => :json, :accept => :json
+      response.body.strip.empty? ? true : JSON.parse(response.body)
+    end
+
+    def post(action, body = {})
+      response = RestClient.post "#{connection}/#{action}", body.to_json, :content_type => :json, :accept => :json
+      response.body.strip.empty? ? true : JSON.parse(response.body)
+    end
+
+  protected
+
+    def authentication
+      "#{api_key}:x"
+    end
+
+    def build_connection
+      "#{use_ssl ? 'https' : 'http'}://#{authentication}@#{subdomain}.#{HOST}"
+    end
+
+  end
+
+end

data/lib/matchstick/room.rb

@@ -0,0 +1,35 @@
+module Matchstick
+
+  class Room < Campfire
+
+    attr_reader :id, :name, :connection
+
+    def initialize(raw_room, connection)
+      @name       = raw_room["name"]
+      @id         = raw_room["id"]
+      @connection = connection
+    end
+
+    def speak(message)
+      post("room/#{@id}/speak", {:message =>
+        {:type => "TextMessage", :body => message}
+      })
+    end
+
+    def paste(message)
+      post("room/#{@id}/speak", {:message =>
+        {:type => "PasteMessage", :body => message}
+      })
+    end
+
+    def join
+      post("room/#{@id}/join")
+    end
+
+    def leave
+      post("room/#{@id}/leave")
+    end
+
+  end
+
+end

data/matchstick.gemspec

@@ -0,0 +1,77 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{matchstick}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Kyle Daigle"]
+  s.date = %q{2011-01-03}
+  s.description = %q{A simple framework for communicating with 37signals' Campfire API. Currently still a work in progress.}
+  s.email = %q{kyle@digitalworkbox.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "lib/matchstick.rb",
+    "lib/matchstick/campfire.rb",
+    "lib/matchstick/room.rb",
+    "matchstick.gemspec",
+    "test/helper.rb",
+    "test/matchstick/campfire_test.rb",
+    "test/matchstick/room_test.rb"
+  ]
+  s.homepage = %q{http://github.com/kdaigle/matchstick}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{A simple framework for communicating with 37signals' Campfire API.}
+  s.test_files = [
+    "test/helper.rb",
+    "test/matchstick/campfire_test.rb",
+    "test/matchstick/room_test.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<rest-client>, ["~> 1.6.1"])
+      s.add_development_dependency(%q<cover_me>, [">= 0"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<mocha>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_runtime_dependency(%q<rest-client>, ["~> 1.6.1"])
+    else
+      s.add_dependency(%q<rest-client>, ["~> 1.6.1"])
+      s.add_dependency(%q<cover_me>, [">= 0"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<mocha>, [">= 0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_dependency(%q<rest-client>, ["~> 1.6.1"])
+    end
+  else
+    s.add_dependency(%q<rest-client>, ["~> 1.6.1"])
+    s.add_dependency(%q<cover_me>, [">= 0"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<mocha>, [">= 0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+    s.add_dependency(%q<rest-client>, ["~> 1.6.1"])
+  end
+end
+

data/test/helper.rb

@@ -0,0 +1,25 @@
+require 'rubygems'
+require 'cover_me'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+require 'mocha'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'matchstick'
+
+class Test::Unit::TestCase
+
+  def post_rest_client_arguments(action, message={})
+    ["#{@connection}/#{action}", message.to_json, {:content_type => :json, :accept => :json}]
+  end
+
+end

data/test/matchstick/campfire_test.rb

@@ -0,0 +1,41 @@
+require 'helper'
+
+class CampfireTest < Test::Unit::TestCase
+
+  context "With a matchstick" do
+
+    setup do
+      @matchstick = Matchstick::Campfire.new("samplebusiness", "123abc", true)
+    end
+
+    should "have a valid subdomain" do
+      assert_equal "samplebusiness", @matchstick.subdomain
+    end
+
+    should "have a valid API key" do
+      assert_equal "123abc", @matchstick.api_key
+    end
+
+    should "have build a valid connection" do
+      assert_equal "https://123abc:x@samplebusiness.campfirenow.com", @matchstick.connection
+    end
+
+    should "return and build a set of rooms" do
+      json_string = {"rooms" => [
+        {"id" => 1, "name" => "Business"},
+        {"id" => 2, "name" => "Funtimes"}
+      ]}.to_json.to_s
+
+      response = RestClient::Response.create(json_string, 200, {})
+
+      RestClient.expects(:get).with("https://123abc:x@samplebusiness.campfirenow.com/rooms", {:content_type => :json, :accept => :json}).returns(response)
+
+      result = @matchstick.rooms
+
+      assert_equal 2, result.size
+      assert result.all? {|r| r.instance_of?(Matchstick::Room) }
+    end
+
+  end
+
+end

data/test/matchstick/room_test.rb

@@ -0,0 +1,57 @@
+require 'helper'
+
+class RoomTest < Test::Unit::TestCase
+
+  context "With a room" do
+
+    setup do
+      @connection = "https://123abc:x@samplebusiness.campfirenow.com"
+      raw_room   = {"id" => 12345, "name" => "Business Room", "created_at" => Time.now.to_s}
+      @room = Matchstick::Room.new(raw_room, @connection)
+    end
+
+    should "have a valid name" do
+      assert_equal "Business Room", @room.name
+    end
+
+    should "have a valid id" do
+      assert_equal 12345, @room.id
+    end
+
+    should "speak a message to this room" do
+      json_string = {:message => {:type => "TextMessage", :body => "Hello World"}}.to_json.to_s
+      response = RestClient::Response.create(json_string, 200, {})
+
+      RestClient.expects(:post).with( *post_rest_client_arguments("room/12345/speak", {:message => {:type => "TextMessage", :body => "Hello World"}}) ).returns(response)
+
+      @room.speak("Hello World")
+    end
+
+    should "speak a pasted message to this room" do
+      json_string = {:message => {:type => "TextMessage", :body => "PasteMessage"}}.to_json.to_s
+      response = RestClient::Response.create(json_string, 200, {})
+
+      RestClient.expects(:post).with( *post_rest_client_arguments("room/12345/speak", {:message => {:type => "PasteMessage", :body => "Hello World"}}) ).returns(response)
+
+      @room.paste("Hello World")
+    end
+
+    should "join this room" do
+      response = RestClient::Response.create(" ", 200, {})
+
+      RestClient.expects(:post).with( *post_rest_client_arguments("room/12345/join") ).returns(response)
+
+      @room.join
+    end
+
+    should "leave this room" do
+      response = RestClient::Response.create(" ", 200, {})
+
+      RestClient.expects(:post).with( *post_rest_client_arguments("room/12345/leave") ).returns(response)
+
+      @room.leave
+    end
+
+  end
+
+end

metadata

@@ -0,0 +1,179 @@
+--- !ruby/object:Gem::Specification 
+name: matchstick
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Kyle Daigle
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-01-03 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rest-client
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 6
+        - 1
+        version: 1.6.1
+  type: :runtime
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: cover_me
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 5
+        - 2
+        version: 1.5.2
+  type: :development
+  prerelease: false
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: rest-client
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 6
+        - 1
+        version: 1.6.1
+  type: :runtime
+  prerelease: false
+  version_requirements: *id007
+description: A simple framework for communicating with 37signals' Campfire API. Currently still a work in progress.
+email: kyle@digitalworkbox.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/matchstick.rb
+- lib/matchstick/campfire.rb
+- lib/matchstick/room.rb
+- matchstick.gemspec
+- test/helper.rb
+- test/matchstick/campfire_test.rb
+- test/matchstick/room_test.rb
+has_rdoc: true
+homepage: http://github.com/kdaigle/matchstick
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 2422956089847336013
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A simple framework for communicating with 37signals' Campfire API.
+test_files: 
+- test/helper.rb
+- test/matchstick/campfire_test.rb
+- test/matchstick/room_test.rb