firering 1.3.0 → 1.4.0

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2010 Emmanuel Oga
+Copyright (c) 2013 Emmanuel Oga
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/{README.rdoc → README.md}

@@ -1,40 +1,62 @@
-= firering
+# firering
 
 Campfire API interface powered by eventmachine, em-http-request and yajl-ruby.
 
-  require 'firering'
+## Sample code
 
-  print "Enter subdomain: "; subdomain = gets.chomp
-  print "Enter user: "     ; login     = gets.chomp
-  print "Enter password: " ; password  = gets.chomp
+```ruby
+require 'firering'
 
-  conn = Firering::Connection.new("http://#{subdomain}.campfirenow.com") do |c|
-    c.login = login
-    c.password = password
-    c.max_retries = 10 # default to -1, which means perform connection retries on drop forever.
-  end
+print "Enter subdomain: "; subdomain = gets.chomp
+print "Enter user: "     ; login     = gets.chomp
+print "Enter password: " ; password  = gets.chomp
 
-  EM.run do
-    conn.authenticate do |user|
-      conn.rooms do |rooms|
+conn = Firering::Connection.new("http://#{subdomain}.campfirenow.com") do |c|
+  c.login = login
+  c.password = password
+  c.max_retries = 10 # default to -1, which means perform connection retries on drop forever.
+end
 
-        rooms.each do |room|
-          if room.name == "Room Name"
+EM.run do
+  conn.authenticate do |user|
+    conn.rooms do |rooms|
 
-            room.stream do |message|
-              message.user { |user| puts "#{user}: #{message}" }
-            end
+      rooms.each do |room|
+        if room.name == "Room Name"
 
+          room.stream do |message|
+            message.user { |user| puts "#{user}: #{message}" }
           end
-        end
 
+        end
       end
-    end
 
-    trap("INT") { EM.stop }
+    end
   end
 
-= campf-notify
+  trap("INT") { EM.stop }
+end
+```
+
+## Specifying connection options:
+
+An user agent can be specified.
+HTTP Options correspond to [EM::HTTPRequest options](https://github.com/igrigorik/em-http-request/wiki/Issuing-Requests):
+
+```ruby
+conn = Firering::Connection.new("http://#{subdomain}.campfirenow.com") do |conn|
+  conn.user_agent = "My Cool App 1.0"
+  conn.http_options = {
+    proxy: {
+      host: url,
+      port: port,
+      authorization: [username, password]
+    }
+  }
+end
+```
+
+## campf-notif
 
 The gem bundles an executable script for spawning libnotify powered
 notifications.  To be able to use it, check your distro package repositories
@@ -52,7 +74,7 @@ Once the variables are set, run the script as follows:
 
 And watch the lovely notifications each time something is posted to a room.
 
-== Running the specs
+## Running the specs
 
 When the specs are run a process is forked where a Rack application is run.
 This rack application serves all the fixtured responses that mimic the working
@@ -63,13 +85,13 @@ fixtures server.
 
 For more details take a look at spec/fixtures/load_server.rb file.
 
-== TODO
+## TODO
 
 * Better API documentation
 * Post files to a room
 * Retrieve recently uploaded files
 
-== Note on Patches/Pull Requests
+## Note on Patches/Pull Requests
 
 * Fork the project.
 * Make your feature addition or bug fix.
@@ -79,17 +101,10 @@ For more details take a look at spec/fixtures/load_server.rb file.
   (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
 * Send me a pull request. Bonus points for topic branches.
 
-== Contributors
+## Contributors
 
-* indirect (Andre Arko), https://github.com/EmmanuelOga/firering/pull/1 ,
-                         https://github.com/EmmanuelOga/firering/pull/2 ,
-                         https://github.com/EmmanuelOga/firering/pull/3
-                         https://github.com/EmmanuelOga/firering/pull/7
-* caius (Caius Durling), https://github.com/EmmanuelOga/firering/pull/5
-* cesario (Franck Verrot), https://github.com/EmmanuelOga/firering/pull/6
-* PizzaPowered, https://github.com/PizzaPowered/firering
-* gdb (Greg Brockman), https://github.com/EmmanuelOga/firering/pull/8
+See https://github.com/EmmanuelOga/firering/graphs/contributors
 
-== Copyright
+## Copyright
 
-Copyright (c) 2010 Emmanuel Oga. See LICENSE for details.
+Copyright (c) 2013 Emmanuel Oga. See LICENSE for details.

data/firering.gemspec

@@ -4,8 +4,8 @@ Gem::Specification.new do |s|
   s.rubygems_version = '1.3.5'
 
   s.name              = 'firering'
-  s.version           = '1.3.0'
-  s.date              = '2013-05-15'
+  s.version           = '1.4.0'
+  s.date              = '2013-07-05'
   s.rubyforge_project = 'firering'
 
   s.summary     = "Campfire API interface powered by eventmachine em-http-request and yajl-ruby."
@@ -21,7 +21,7 @@ Gem::Specification.new do |s|
   s.default_executable = 'campf-notify'
 
   s.rdoc_options = ["--charset=UTF-8"]
-  s.extra_rdoc_files = %w[README.rdoc LICENSE]
+  s.extra_rdoc_files = %w[README.md LICENSE]
 
   s.add_dependency('eventmachine', ["~> 1.0.3"])
   s.add_dependency('em-http-request', ["~> 1.0.3"])
@@ -36,7 +36,7 @@ Gem::Specification.new do |s|
   s.files = %w[
     Gemfile
     LICENSE
-    README.rdoc
+    README.md
     Rakefile
     bin/campf-notify
     examples/authenticate.rb

data/lib/firering.rb

@@ -5,7 +5,7 @@ require 'yajl'
 require 'em-http'
 
 module Firering
-  VERSION = '1.3.0'
+  VERSION = '1.4.0'
 
   Error = Class.new(StandardError)
 

data/lib/firering/connection.rb

@@ -11,12 +11,18 @@ module Firering
     attr_accessor :password
     attr_accessor :token
     attr_accessor :login
+    attr_accessor :user_agent
+
+    # HTTP Options correspond to EM::HTTPRequest options:
+    # https://github.com/igrigorik/em-http-request/wiki/Issuing-Requests
+    attr_accessor :http_options
 
     attr_reader :performed_retries
 
     def initialize(host, streaming_host = "https://streaming.campfirenow.com")
       @retry_delay, @redirects, @max_retries, @performed_retries = 2, 1, -1, 0
       self.host, self.streaming_host = host, streaming_host
+      self.user_agent = "firering library version #{VERSION}"
       yield self if block_given?
     end
 
@@ -43,7 +49,7 @@ module Firering
     def parameters(data = nil)
       parameters = {
         :redirects => redirects,
-        :head => auth_headers.merge("Content-Type" => "application/json")
+        :head => auth_headers.merge("Content-Type" => "application/json").merge('User-Agent' => user_agent)
       }
       parameters.merge!(:body => data.is_a?(String) ? data : Yajl::Encoder.encode(data)) if data
       parameters
@@ -53,7 +59,7 @@ module Firering
       uri = host.join(path)
       logger.info("performing request to #{uri}")
 
-      http = EventMachine::HttpRequest.new(uri).send(method, parameters(data))
+      http = EventMachine::HttpRequest.new(uri, http_options || {}).send(method, parameters(data))
 
       http.errback do
         perform_retry(http) do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: firering
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-15 00:00:00.000000000 Z
+date: 2013-07-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: eventmachine
@@ -129,12 +129,12 @@ executables:
 - campf-notify
 extensions: []
 extra_rdoc_files:
-- README.rdoc
+- README.md
 - LICENSE
 files:
 - Gemfile
 - LICENSE
-- README.rdoc
+- README.md
 - Rakefile
 - bin/campf-notify
 - examples/authenticate.rb
@@ -211,7 +211,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2244475144513813506
+      hash: 4060696139980185122
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: