sparks 0.3 → 0.4

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Sparks changelog
 
+## Version 0.4 (20 January 2013)
+
+  - broke everything. sorry.
+  - streaming now works for more than a few minutes!
+  - handles both very small and very large JSON objects
+  - uses Yajl for streaming JSON parsing
+  - uses net-http-persistent to make repeated requests much faster
+  - removed Room and Campfire classes, now super...minimal. or something.
+
 ## Version 0.3 (7 October 2011)
 
   - added support for play and tweet message types (@imajes)

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/lib/sparks.rb

@@ -1,124 +1,170 @@
-require 'uri'
-require 'json'
-require 'net/https'
+require 'logger'
+require 'net/http/persistent'
+require 'yajl'
 
 # sparks, a tiny Campfire library
 
 # Usage:
-#   c = Sparks::Campfire.new('subdomain', 'abc123')
-#   r = c.room_named "Room Name"
-#   r.say "hi there"
-#   r.paste "class Foo\nend"
-module Sparks
-  class Room
-    attr_accessor :id
-
-    def initialize api, name, id
-      @api  = api
-      @name = name
-      @id   = id
-    end
+#   c = Sparks.new('subdomain', 'abc123')
+#   r = c.room "Room Name"
+#   c.say r["id"], "hi there"
+#   c.paste r["id"], "class Foo\nend"
+class Sparks
+  attr_reader :logger
+
+  def initialize subdomain, token, opts = {}
+    @base   = URI("https://#{subdomain}.campfirenow.com")
+    @token  = token
+    @logger = opts[:logger] || Logger.new(STDOUT)
+    @http   = Net::HTTP::Persistent.new("sparks")
+    @http.ca_file = opts[:ca_file] if opts[:ca_file]
+    @rooms ||= {}
+  end
 
-    def method_missing method, *args, &block
-      if @api.respond_to? method
-        args.unshift(@id)
-        @api.send method, *args, &block
-      end
-    end
+  def me
+    user("me")
   end
 
-  class Campfire
-    attr_reader :uri, :token, :pass
+  def user(id)
+    req("/users/#{id}")[:user]
+  end
 
-    def initialize subdomain, token, opts = {}
-      @uri   = URI.parse("https://#{subdomain}.campfirenow.com")
-      @token = token
-      @pass  = 'x'
+  def room_named(name)
+    req("/rooms")[:rooms].find{|r| r[:name] == name }
+  end
 
-      @http             = Net::HTTP.new(uri.host, uri.port)
-      @http.use_ssl     = true
-      @http.verify_mode = OpenSSL::SSL::VERIFY_PEER
-      campfire_ca_certs = File.expand_path("../rapidssl.crt", __FILE__)
-      @http.ca_file     = opts[:ca_file] || campfire_ca_certs
+  def room(id)
+    @rooms[id] ||= begin
+      req("/room/#{id.to_s}")[:room]
     end
+  end
 
-    def room_named name
-      r = rooms.find{|r| r["name"] == name }
-      r ? Room.new(self, name, r["id"]) : nil
-    end
+  def join(id)
+    req("/room/#{id}/join", :post)
+  end
 
-    def rooms
-      @http.start do |http|
-        req = Net::HTTP::Get.new "/rooms.json"
-        req['Content-Type'] = 'application/json'
-        req.basic_auth token, pass
-        begin
-          JSON.parse(http.request(req).body)["rooms"]
-        rescue JSON::ParserError
-          {}
-        end
-      end
-    end
+  def leave(id)
+    req("/room/#{id}/leave", :post)
+  end
 
-    def post room_id, message, type = nil
-      data = {'body' => message}
-      data.merge!('type' => type) if type
-      json = JSON.generate('message' => data)
+  def speak(id, message, type = 'TextMessage')
+    data = {'body' => message, 'type' => type}
+    json = Yajl::Encoder.encode('message' => data)
+    req("/room/#{id}/speak", json)
+  end
+  alias_method :say, :speak
 
-      @http.start do |http|
-        req = Net::HTTP::Post.new "/room/#{room_id}/speak.json"
-        req['Content-Type'] = 'application/json'
-        req.basic_auth token, pass
-        http.request(req, json)
-      end
-    end
+  def paste(id, message)
+    speak id, message, 'PasteMessage'
+  end
 
-    def speak room_id, message
-      post room_id, message, 'TextMessage'
-    end
-    alias_method :say, :speak
+  def play(id, message)
+    speak id, message, 'SoundMessage'
+  end
 
-    def paste room_id, message
-      post room_id, message, 'PasteMessage'
-    end
+  def tweet(id, message)
+    speak id, message, 'TweetMessage'
+  end
 
-    def play room_id, message
-      post room_id, message, 'SoundMessage'
-    end
-    
-    def tweet room_id, message
-      post room_id, message, 'TweetMessage'
-    end
+  def watch(id)
+    # campfire won't let you stream until you've joined the room
+    join(id)
+
+    # don't allow retries if we've never connected before.
+    retries ||= nil
+
+    uri = URI("https://streaming.campfirenow.com") + "/room/#{id}/live.json"
+    logger.debug "Ready to stream from #{uri}"
+
+    request = Net::HTTP::Get.new(uri.path)
+    request.basic_auth @token, "x"
+
+    @http.request(uri, request) do |response|
+      logger.debug "Connected and streaming from room #{id}"
+      # connected! allow retries.
+      retries = 0
 
-    def join room_id
-      @http.start do |http|
-        req = Net::HTTP::Post.new "/room/#{room_id}/join.xml"
-        req.basic_auth token, pass
-        http.request(req)
+      # Set up a Yajl stream parser
+      parser = Yajl::Parser.new(:symbolize_keys => true)
+      parser.on_parse_complete = -> hash { yield hash }
+
+      # Feed chunks into the stream parser
+      response.read_body do |chunk|
+        # Campfire keepalive pings
+        next if chunk == " "
+        parser << chunk
       end
     end
+  rescue Yajl::ParseError,          # Bad JSON in the response
+      SystemCallError,              # All Errno errors
+      SocketError,                  # Errors from socket operations
+      Net::HTTP::Persistent::Error, # Timeout, SSL, or connection error
+      Net::HTTPBadResponse,         # response wasn't 2xx
+      Net::HTTPHeaderSyntaxError,   # response header issue
+      Net::ProtocolError => e       # not http
+    # pass through errors if we haven't ever connected
+    raise e unless retries
+    # if we connected at least once, try, try, again
+    retries += 1
+    logger.error "#{e.class}: #{e.message}"
+    logger.error "Trying to stream again in #{retries * 2}s"
+    sleep retries * 2
+    retry
+  end
 
-    def watch room_id
-      uri = URI.parse('https://streaming.campfirenow.com')
-
-      x             = Net::HTTP.new(uri.host, uri.port)
-      x.use_ssl     = true
-      x.verify_mode = OpenSSL::SSL::VERIFY_NONE
-
-      x.start do |http|
-        req = Net::HTTP::Get.new "/room/#{room_id}/live.json"
-        req.basic_auth token, pass
-        http.request(req) do |res|
-          res.read_body do |chunk|
-            unless chunk.strip.empty?
-              chunk.split("\r").each do |message|
-                yield JSON.parse(message)
-              end
-            end
-          end
-        end
-      end
+  def req(uri, body = nil)
+    uri = @base + (uri + ".json") unless uri.is_a?(URI)
+    logger.debug "#{body ? 'POST' : 'GET'} #{uri}"
+
+    if body
+      request = Net::HTTP::Post.new(uri.path)
+      request.body = body unless body == :post
+    else
+      request = Net::HTTP::Get.new(uri.path)
     end
+    request.content_type = "application/json"
+    request.basic_auth @token, "x"
+
+    retries ||= 0
+    response = @http.request(uri, request)
+    response.value   # raises if response is not 2xx
+    parse_response(response)
+
+  rescue Net::HTTPRetriableError => e # response was 3xx
+    location = URI(response['location'])
+    logger.info "Request redirected to #{location}"
+    sleep 2
+    req(location, body)
+
+  rescue Net::HTTPServerException => e # response was 4xx
+    msg = "Authorization failed: HTTP #{response.code}"
+    msg << ": " << request.body if request.body && !request.body.empty?
+    raise msg
+
+  rescue SystemCallError,           # All Errno errors
+      Net::HTTP::Persistent::Error, # Timeout, SSL, or connection error
+      Net::HTTPBadResponse,         # response wasn't 2xx
+      Net::HTTPHeaderSyntaxError,   # response header issue
+      Net::ProtocolError => e       # not http
+    # Retry if something goes wrong
+    retries += 1
+    logger.info "Request failed: #{e.class}: #{e.message}"
+    logger.info "Going to retry request in #{retries * 2}s"
+    sleep retries * 2
+    retry
+  end
+
+private
 
+  def parse_response(response)
+    if response.body.strip.empty?
+      true
+    else
+      Yajl::Parser.parse(response.body, :symbolize_keys => true)
+    end
+  rescue Yajl::ParseError
+    logger.debug "Couldn't parse #{res.inspect}: #{res.body.inspect}"
+    {}
   end
+
 end

data/lib/sparks/version.rb

@@ -1,3 +1,3 @@
-module Sparks
-  VERSION = "0.3"
+class Sparks
+  VERSION = "0.4"
 end

data/sparks.gemspec

@@ -1,23 +1,24 @@
-# -*- encoding: utf-8 -*-
-$:.push File.expand_path("../lib", __FILE__)
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "sparks/version"
 
-Gem::Specification.new do |s|
-  s.name        = "sparks"
-  s.version     = Sparks::VERSION
-  s.platform    = Gem::Platform::RUBY
-  s.authors     = ["André Arko"]
-  s.email       = ["andre@arko.net"]
-  s.homepage    = "http://github.com/indirect/sparks"
-  s.summary     = %q{A tiny Campfire client API}
-  s.description = %q{A tiny Campfire client API that only uses the standard library}
+Gem::Specification.new do |gem|
+  gem.name        = "sparks"
+  gem.version     = Sparks::VERSION
+  gem.summary     = %q{A tiny Campfire client API}
+  gem.description = %q{Yet another Campfire client. Because oh my god so many dependencies.}
+  gem.authors     = ["André Arko"]
+  gem.email       = ["andre@arko.net"]
+  gem.homepage    = "http://github.com/indirect/sparks"
 
-  s.rubyforge_project = "sparks"
-  s.add_dependency "json"
-  s.add_development_dependency "bundler", "~>1.0"
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
 
-  s.files         = `git ls-files`.split("\n")
-  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  s.require_paths = ["lib"]
+  gem.add_dependency "yajl-ruby", "~> 1.1"
+  gem.add_dependency "net-http-persistent", "~> 2.8"
+
+  gem.add_development_dependency "rake", "~> 10.0"
+  gem.add_development_dependency "bundler", "~> 1.2"
 end

metadata

@@ -1,102 +1,118 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: sparks
-version: !ruby/object:Gem::Version 
-  hash: 13
-  prerelease: false
-  segments: 
-  - 0
-  - 3
-  version: "0.3"
+version: !ruby/object:Gem::Version
+  version: '0.4'
+  prerelease: 
 platform: ruby
-authors: 
-- "Andr\xC3\xA9 Arko"
+authors:
+- André Arko
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-10-07 00:00:00 -10:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: json
+date: 2013-04-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: yajl-ruby
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
   prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: net-http-persistent
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.8'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: bundler
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.8'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 15
-        segments: 
-        - 1
-        - 0
-        version: "1.0"
+      - !ruby/object:Gem::Version
+        version: '1.2'
   type: :development
-  version_requirements: *id002
-description: A tiny Campfire client API that only uses the standard library
-email: 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
+description: Yet another Campfire client. Because oh my god so many dependencies.
+email:
 - andre@arko.net
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - CHANGELOG.md
+- Gemfile
 - README.md
 - Rakefile
 - lib/rapidssl.crt
 - lib/sparks.rb
 - lib/sparks/version.rb
 - sparks.gemspec
-has_rdoc: true
 homepage: http://github.com/indirect/sparks
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
-rubyforge_project: sparks
-rubygems_version: 1.3.7
+rubyforge_project: 
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: A tiny Campfire client API
 test_files: []
-