em-campfire 1.1.3 → 1.2.3

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    ZjdkZmM3ZmQyMjJmZWJlODBlNGFiZmRkNDU1MWI1ZGQ3ZTA0NWY5OQ==
-  data.tar.gz: !binary |-
-    ZTA3ODQ2NjNmZDgzMDE4NTFiZjdjOWM3ZTc5NDM2MjEwOWE3ZDljOA==
+SHA1:
+  metadata.gz: bf1a5b37a9168bc545a846cf3711eac88cab638c
+  data.tar.gz: 3e63b30df129cd68330ef71bf54d8e1f87610a70
 SHA512:
-  metadata.gz: !binary |-
-    YjA4ZjU3NjBmMmJkMmIwMzAwOTdkMzgwZTQ0MThmODg5NjBjNDJhMGY2MjEz
-    ZjEwYTkzN2ZhYWYxZDA1YzE0ZTc0MjBiMzFkNzk5OWNkM2RjM2M3NDMyYThl
-    YzUyMGIzY2Q4ZWRhMGRmMWUyZTgxN2Y4NWJmZjE3MDQ4MDNkZmQ=
-  data.tar.gz: !binary |-
-    MWNhNjQ5MzdkYzBhNTNlMDJlNGU3Y2QwYzc4NjA2MjZhYzQ1M2ZlM2ViNjJi
-    ODdjNTRhNDMxOWY0YjY1MzAwZjUwNTNiYTY5MjdhMDVkOTU3ZGE2NzBmN2Zm
-    M2JlMDM5NDgyZjUyNDQzMWM3OTNmYjY5NGM0MjhmY2E4MzlkYzM=
+  metadata.gz: 9d43e8055e0ae06c7a499f7d6afbe24c9b9948f87a87943c45d86beee10001ff5c0623258929c2009b58e41efbc5270135473e77ad1799f6f4c4e7d6c97eb5fa
+  data.tar.gz: b0c9e65911c33c4d9a20766df5b46449088437ab6f2c948e25ef9444f4db003edb267567d04b8e5831e0d4f5953201af4481a3c30e00871c1d34c28c24c6e7d5

data/README.md

@@ -56,7 +56,8 @@ EM.run {
     :logger => Logger::Syslog.new('process_name', Syslog::LOG_PID | Syslog::LOG_CONS),
     :cache => custom_cache_object,
     :ignore_self => true,
-    :ignore_timestamps => true
+    :ignore_timestamps => true,
+    :user_agent => "my bot"
   )
 
   # more code
@@ -85,6 +86,10 @@ em-campfire receives messages that it posted on it's streaming connections. By d
 
 Campfire sends periodic timestamp messages. They're useless for most applications, so set this option and they will be totally ignored.
 
+#### :user_agent
+
+Sets the User-Agent header for the EventMachine::HttpRequests to Campfire. Defaults to "em-campfire".
+
 ## Requirements
 
 I've tested it in Ruby >= 1.9.3.

data/lib/em-campfire/messages.rb

@@ -23,7 +23,7 @@ module EventMachine
         end
         
         url = "https://#{subdomain}.campfirenow.com/room/#{room_id}/speak.json"
-        http = EventMachine::HttpRequest.new(url).post :head => {'Content-Type' => 'application/json', 'authorization' => [api_key, 'X']}, :body => Yajl::Encoder.encode({:message => {:body => payload.to_s, :type => type}})
+        http = EventMachine::HttpRequest.new(url).post :head => {'Content-Type' => 'application/json', 'authorization' => [api_key, 'X'], 'user-agent' => user_agent}, :body => Yajl::Encoder.encode({:message => {:body => payload.to_s, :type => type}})
         http.errback { logger.error "Couldn't connect to #{url} to post message \"#{payload}\" to room #{room_id}" }
         http.callback {
           if [200,201].include? http.response_header.status

data/lib/em-campfire/rooms.rb

@@ -7,7 +7,7 @@ module EventMachine
       def join(room_id, &blk)
         logger.info "Joining room #{room_id}"
         url = "https://#{subdomain}.campfirenow.com/room/#{room_id}/join.json"
-        http = EventMachine::HttpRequest.new(url).post :head => {'Content-Type' => 'application/json', 'authorization' => [api_key, 'X']}
+        http = EventMachine::HttpRequest.new(url).post :head => {'Content-Type' => 'application/json', 'authorization' => [api_key, 'X'], 'user-agent' => user_agent}
         http.errback { logger.error "Error joining room: #{room_id}" }
         http.callback {
           if http.response_header.status == 200
@@ -26,7 +26,7 @@ module EventMachine
 
         url = "https://streaming.campfirenow.com/room/#{room_id}/live.json"
         # Timeout per https://github.com/igrigorik/em-http-request/wiki/Redirects-and-Timeouts
-        http = EventMachine::HttpRequest.new(url, :connect_timeout => 20, :inactivity_timeout => 4).get :head => {'authorization' => [api_key, 'X']}
+        http = EventMachine::HttpRequest.new(url, :connect_timeout => 20, :inactivity_timeout => 4).get :head => {'authorization' => [api_key, 'X'], 'user-agent' => user_agent}
         http.errback {
           logger.error "Couldn't stream room #{room_id} at url #{url}, error was #{http.error}"
           EM.next_tick {stream(room_id)}
@@ -59,7 +59,7 @@ module EventMachine
           etag_header = {"ETag" => cached_room_data["etag"]}
         end
 
-        http = EventMachine::HttpRequest.new(url).get :head => {'authorization' => [api_key, 'X'], 'Content-Type'=>'application/json'}.merge(etag_header)
+        http = EventMachine::HttpRequest.new(url).get :head => {'authorization' => [api_key, 'X'], 'Content-Type'=>'application/json', 'user-agent' => user_agent}.merge(etag_header)
         http.errback { logger.error "Couldn't connect to url #{url} to fetch room data" }
         http.callback {
           if http.response_header.status == 200
@@ -84,7 +84,7 @@ module EventMachine
           etag_header = {"ETag" => cached_room_list_data["etag"]}
         end
 
-        http = EventMachine::HttpRequest.new(url).get :head => {'Content-Type' => 'application/json', 'authorization' => [api_key, 'X']}.merge(etag_header)
+        http = EventMachine::HttpRequest.new(url).get :head => {'Content-Type' => 'application/json', 'authorization' => [api_key, 'X'], 'user-agent' => user_agent}.merge(etag_header)
 
         http.errback { logger.error "Error processing url #{url} to fetch room data: #{http.error}" }
         http.callback {

data/lib/em-campfire/users.rb

@@ -9,7 +9,7 @@ module EventMachine
           etag_header = {"ETag" => cached_user_data["etag"]}
         end
 
-        http = EventMachine::HttpRequest.new(url).get(:head => {'authorization' => [api_key, 'X'], "Content-Type" => "application/json"}.merge(etag_header))
+        http = EventMachine::HttpRequest.new(url).get(:head => {'authorization' => [api_key, 'X'], "Content-Type" => "application/json", 'user-agent' => user_agent}.merge(etag_header))
 
         http.callback do
           if http.response_header.status == 200
@@ -37,7 +37,7 @@ module EventMachine
           etag_header = {"ETag" => cached_user_data["etag"]}
         end
 
-        http = EventMachine::HttpRequest.new(url).get(:head => {'authorization' => [api_key, 'X'], "Content-Type" => "application/json"}) #.merge(etag_header)
+        http = EventMachine::HttpRequest.new(url).get(:head => {'authorization' => [api_key, 'X'], "Content-Type" => "application/json", 'user-agent' => user_agent}) #.merge(etag_header)
         http.callback do
           if http.response_header.status == 200
             logger.debug "Got the user data for self"

data/lib/em-campfire/version.rb

@@ -1,5 +1,5 @@
 module EventMachine
   class Campfire
-    VERSION = "1.1.3"
+    VERSION = "1.2.3"
   end
 end

data/lib/em-campfire.rb

@@ -12,7 +12,7 @@ require "em-campfire/cache"
 
 module EventMachine
   class Campfire
-    attr_accessor :logger, :verbose, :subdomain, :api_key, :ignore_timestamps
+    attr_accessor :logger, :verbose, :subdomain, :api_key, :ignore_timestamps, :user_agent
     
     include Connection
     include Rooms
@@ -61,5 +61,9 @@ module EventMachine
     def ignore_timestamps?
       self.ignore_timestamps || false
     end
+
+    def user_agent
+      @user_agent || "em-campfire"
+    end
   end # Campfire
 end # EventMachine

data/spec/lib/em-campfire_spec.rb

@@ -95,5 +95,20 @@ describe EventMachine::Campfire do
       EM.run_block { a(EM::Campfire, :ignore_timestamps => true).ignore_timestamps?.should be_true }
     end
   end
+
+  describe "#user_agent" do
+    before :each do
+      EM.run_block { @adaptor = a EM::Campfire }
+    end
+
+    it "should default to em-campfire" do
+      @adaptor.user_agent.should eql("em-campfire")
+    end
+
+    it "should be overridable at initialization" do
+      @self_data_request_stub = stub_override_user_agent_self_data_request
+      EM.run_block { a(EM::Campfire, :user_agent => "testing/1.0").user_agent.should eql("testing/1.0") }
+    end
+  end
 end
 

data/spec/messages_helper.rb

@@ -4,6 +4,6 @@ require "rooms_helper"
 def stub_message_post_request(response_code = 201)
   message_post_url = "https://#{valid_params[:subdomain]}.campfirenow.com/room/123/speak.json"
   stub_request(:post, message_post_url).
-    with(:headers => {'Authorization'=>[valid_params[:api_key], 'X'], 'Content-Type' => 'application/json'}).
+    with(:headers => {'Authorization'=>[valid_params[:api_key], 'X'], 'Content-Type' => 'application/json', 'User-Agent' => valid_params[:user_agent]}).
     to_return(:status => response_code, :body => "", :headers => {})
-end
+end

data/spec/rooms_helper.rb

@@ -20,7 +20,7 @@ end
 def stub_join_room_request(room, response_code = 200)
   url = "https://#{valid_params[:subdomain]}.campfirenow.com/room/#{room}/join.json"
   stub_request(:post, url).
-    with(:headers => {'Authorization'=>[valid_params[:api_key], 'X'], 'Content-Type'=>'application/json'}).
+    with(:headers => {'Authorization'=>[valid_params[:api_key], 'X'], 'Content-Type'=>'application/json', 'User-Agent' => valid_params[:user_agent]}).
     to_return(:status => response_code, :body => "", :headers => {})
 end
 
@@ -32,13 +32,13 @@ end
 
 def stub_stream_room_request(room_id, body, response_code = 200)
   stub_request(:get, stream_url_for_room(room_id)).
-    with(:headers => {'Authorization'=>[valid_params[:api_key], 'X']}).
+    with(:headers => {'Authorization'=>[valid_params[:api_key], 'X'], 'User-Agent' => valid_params[:user_agent]}).
     to_return(:status => response_code, :body => body, :headers => {})
 end
 
 def stub_timeout_stream_room_request(room_id)
   stub_request(:get, stream_url_for_room(room_id)).
-    with(:headers => {'Authorization'=>[valid_params[:api_key], 'X']}).
+    with(:headers => {'Authorization'=>[valid_params[:api_key], 'X'], 'User-Agent' => valid_params[:user_agent]}).
     to_timeout
 end
 
@@ -59,13 +59,13 @@ end
 def stub_room_data_request(room_id, response_code = 200)
   body = response_code == 200 ? Yajl::Encoder.encode(:room => valid_room_cache_data[room_id]) : ""
   stub_request(:get, room_data_url(room_id)).
-    with(:headers => {'Authorization'=>['6124d98749365e3db2c9e5b27ca04db6', 'X'], 'Content-Type'=>'application/json'}).
+    with(:headers => {'Authorization'=>['6124d98749365e3db2c9e5b27ca04db6', 'X'], 'Content-Type'=>'application/json', 'User-Agent' => valid_params[:user_agent]}).
     to_return(:status => response_code, :body => body, :headers => {:ETag => etag_for_data(valid_room_cache_data[room_id])})
 end
 
 def stub_timeout_room_data_request(room_id)
   stub_request(:get, room_data_url(room_id)).
-    with(:headers => {'Authorization'=>['6124d98749365e3db2c9e5b27ca04db6', 'X']}).
+    with(:headers => {'Authorization'=>['6124d98749365e3db2c9e5b27ca04db6', 'X'], 'User-Agent' => valid_params[:user_agent]}).
     to_timeout
 end
 
@@ -79,13 +79,13 @@ def stub_room_list_data_request(response_code = 200)
   body = response_code == 200 ? Yajl::Encoder.encode(room_list_data_api_response) : ""
   etag_header = response_code == 200 ? {:ETag => 'new etag'} : {:ETag => etag_for_room_list_data}
   stub_request(:get, rooms_data_url).
-    with(:headers => {'Authorization'=>['6124d98749365e3db2c9e5b27ca04db6', 'X'], 'Content-Type'=>'application/json', 'ETag' => etag_for_room_list_data}).
+    with(:headers => {'Authorization'=>['6124d98749365e3db2c9e5b27ca04db6', 'X'], 'Content-Type'=>'application/json', 'User-Agent' => valid_params[:user_agent], 'ETag' => etag_for_room_list_data}).
     to_return(:status => response_code, :body => body, :headers => etag_header)
 end
 
 def stub_timeout_room_list_data_request
   stub_request(:get, rooms_data_url).
-    with(:headers => {'Authorization'=>['6124d98749365e3db2c9e5b27ca04db6', 'X'], 'Content-Type'=>'application/json'}).
+    with(:headers => {'Authorization'=>['6124d98749365e3db2c9e5b27ca04db6', 'X'], 'Content-Type'=>'application/json'}, 'User-Agent' => valid_params[:user_agent]).
     to_timeout
 end
 
@@ -95,4 +95,4 @@ end
 
 def etag_for_room_list_data
   etag_for_data(room_list_data_api_response)
-end
+end

data/spec/spec_helper.rb

@@ -37,10 +37,11 @@ def etag_for_data(data)
 end
 
 def valid_params
-  {:api_key => "6124d98749365e3db2c9e5b27ca04db6", :subdomain => "oxygen", :ignore_self => false} 
+  {:api_key => "6124d98749365e3db2c9e5b27ca04db6", :subdomain => "oxygen", :ignore_self => false, :user_agent => "em-campfire"}
 end
 
 class ModuleHarness
   def subdomain; valid_params[:subdomain]; end
   def api_key; valid_params[:api_key]; end
+  def user_agent; valid_params[:user_agent]; end
 end

data/spec/users_helper.rb

@@ -9,13 +9,13 @@ end
 def stub_user_data_request(user_id, response_code = 200)
   body = response_code == 200 ? Yajl::Encoder.encode(:user => valid_user_cache_data[user_id]) : ""
   stub_request(:get, "https://#{valid_params[:subdomain]}.campfirenow.com/users/#{user_id}.json").
-    with(:headers => {'Authorization'=>['6124d98749365e3db2c9e5b27ca04db6', 'X'], 'Content-Type'=>'application/json'}).
+    with(:headers => {'Authorization'=>['6124d98749365e3db2c9e5b27ca04db6', 'X'], 'Content-Type'=>'application/json', 'User-Agent' => valid_params[:user_agent]}).
     to_return(:status => response_code, :body => body, :headers => {:ETag => etag_for_data(valid_user_cache_data[user_id])})
 end
 
 def stub_timeout_user_data_request(user_id)
   stub_request(:get, "https://#{valid_params[:subdomain]}.campfirenow.com/users/#{user_id}.json").
-    with(:headers => {'Authorization'=>['6124d98749365e3db2c9e5b27ca04db6', 'X'], 'Content-Type'=>'application/json'}).
+    with(:headers => {'Authorization'=>['6124d98749365e3db2c9e5b27ca04db6', 'X'], 'Content-Type'=>'application/json', 'User-Agent' => valid_params[:user_agent]}).
     to_timeout
 end
 
@@ -24,12 +24,19 @@ end
 def stub_self_data_request(response_code = 200)
   body = response_code == 200 ? Yajl::Encoder.encode(:user => valid_user_cache_data['me']) : ""
   stub_request(:get, "https://#{valid_params[:subdomain]}.campfirenow.com/users/me.json").
-    with(:headers => {'Authorization'=>['6124d98749365e3db2c9e5b27ca04db6', 'X'], 'Content-Type'=>'application/json'}).
+    with(:headers => {'Authorization'=>['6124d98749365e3db2c9e5b27ca04db6', 'X'], 'Content-Type'=>'application/json', 'User-Agent' => valid_params[:user_agent]}).
+    to_return(:status => response_code, :body => body, :headers => {:ETag => etag_for_data(valid_user_cache_data['me'])})
+end
+
+def stub_override_user_agent_self_data_request(response_code = 200)
+  body = response_code == 200 ? Yajl::Encoder.encode(:user => valid_user_cache_data['me']) : ""
+  stub_request(:get, "https://#{valid_params[:subdomain]}.campfirenow.com/users/me.json").
+    with(:headers => {'Authorization'=>['6124d98749365e3db2c9e5b27ca04db6', 'X'], 'Content-Type'=>'application/json', 'User-Agent' => 'testing/1.0'}).
     to_return(:status => response_code, :body => body, :headers => {:ETag => etag_for_data(valid_user_cache_data['me'])})
 end
 
 def stub_timeout_self_data_request
   stub_request(:get, "https://#{valid_params[:subdomain]}.campfirenow.com/users/me.json").
-    with(:headers => {'Authorization'=>['6124d98749365e3db2c9e5b27ca04db6', 'X'], 'Content-Type'=>'application/json'}).
+    with(:headers => {'Authorization'=>['6124d98749365e3db2c9e5b27ca04db6', 'X'], 'Content-Type'=>'application/json', 'User-Agent' => valid_params[:user_agent]}).
     to_timeout
-end
+end

metadata

@@ -1,125 +1,125 @@
 --- !ruby/object:Gem::Specification
 name: em-campfire
 version: !ruby/object:Gem::Version
-  version: 1.1.3
+  version: 1.2.3
 platform: ruby
 authors:
 - Will Jessop
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-19 00:00:00.000000000 Z
+date: 2014-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: eventmachine
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
 - !ruby/object:Gem::Dependency
   name: yajl-ruby
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.1'
 - !ruby/object:Gem::Dependency
   name: em-http-request
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
 - !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.11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.11'
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.12'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.8.10
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.8.10
 - !ruby/object:Gem::Dependency
   name: simplecov
   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'
 description: Eventmachine campfire API lib
@@ -129,7 +129,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - CONTRIBUTING.md
 - Gemfile
 - LICENSE.md
@@ -163,12 +163,12 @@ 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: []