dynamicdudes-speaking-apps 1.1.3 → 1.2.0

data/README.rdoc

@@ -18,10 +18,15 @@ or with Rails >= 2.1:
 == Configuration
 
 Just before you start sending messages to the http://speakingapps.com API you should configure a few essential things:
-  SpeakingApps::Config.token = 'your_super_secret_token'
+  SpeakingApps.configure do |config|
+    config.token = 'your_super_secret_token'
+  end
   
 If you are on Rails you might want to define which environments should be used for remote logging:
-  SpeakingApps::Config.environments = [ 'staging', 'production' ]
+  SpeakingApps.configure do |config|
+    config.token = 'your_super_secret_token'
+    config.environments = [ 'staging', 'production' ]
+  end
 
 == Usage
 
@@ -44,4 +49,4 @@ and a &block taking version for more readability if you have longer messages:
 * Supported by http://dynamicdudes.com
 
 
-Copyright (c) 2008 rubyphunk, speakingapps.com. See LICENSE for details.
+Copyright (c) 2009 rubyphunk, speakingapps.com. See LICENSE for details.

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
-:patch: 3
+:patch: 0
 :major: 1
-:minor: 1
+:minor: 2

data/lib/speaking_apps.rb

@@ -1,22 +1,42 @@
 require 'timeout'
-require File.dirname(__FILE__) + '/speaking_apps/config'
 require File.dirname(__FILE__) + '/speaking_apps/message_queue'
 
 # This is the place to read about the methods that
 # will help you sending Messages/Logs to the SpeakingApps API Service.
 #
-# Please make sure you set the required SpeakingApps::Config values.
+# Please make sure you set the required SpeakingApps.configure values.
 
 module SpeakingApps
   class << self
-
-    def init(environment = nil) #:nodoc:
+    
+    attr_accessor :token, :environments, :host, :port
+    attr_accessor :environment
+    
+    def init(environment = nil) # :nodoc:
+      @environment = environment
+      @host = 'speakingapps.com'
+      @port = 80
+      @environments = [ :production ]
+    end
+    
+    # Configure SpeakingApps. Puts this in your initializers
+    #
+    #   SpeakingApps.configure do |config|
+    #     config.token = '_your_token_goes_here_'
+    #     config.environments = [ :development, :production ] # Defaults to [ :production ]
+    #   end
+    #
+    def configure # :yields: config
+      yield self
+      
+      @environments = @environments.collect { |e| e.to_sym } if @environments
+      
       unless class_variable_defined?(:@@_message_queue)
-        @@_message_queue = SpeakingApps::MessageQueue.new(environment)
-        ensure_existence_of_service_daemon# if @@_message_queue.environment_valid?
+        @@_message_queue = SpeakingApps::MessageQueue.new(@environment)
+        ensure_existence_of_service_daemon if @@_message_queue.environment_valid?
       end      
     end
-
+    
     # Send a Messages. You can optionally assign Tags.
     #
     # * <tt>SpeakingApps.log('hello World')</tt>
@@ -62,7 +82,7 @@ module SpeakingApps
       end
     end  
     
-    def send_to_app(message)
+    def send_to_app(message) #:nodoc:
       $stdout.puts message
     end
     

data/lib/speaking_apps/daemon/control.rb

@@ -1,4 +1,5 @@
 Daemons.run_proc('speaking-apps', { :dir_mode => :normal, :dir => '/tmp', :multiple => false,:monitor => true}) do
   path = File.expand_path(File.join(File.dirname(__FILE__), 'queue_service.rb'))
-  exec "/usr/bin/env ruby #{path} -p 28128 -- --debug"  
+  debug = "-- --debug" if ARGV.delete('--debug')
+  exec "/usr/bin/env ruby #{path} -p 28128 #{debug}"  
 end

data/lib/speaking_apps/daemon/remote.rb

@@ -36,6 +36,7 @@ module SpeakingApps
       def self.post_to_remote(uri, encoded_post_data)
         uri = URI.parse(uri)      
       
+        debug "Opening connection to #{uri.host}:#{uri.port} / #{uri.path}"
         http = Net::HTTP.new(uri.host, uri.port)
         http.use_ssl = false
         
@@ -48,7 +49,7 @@ module SpeakingApps
         
         case api_response
         when Net::HTTPCreated
-          debug "Send message: '#{encoded_post_data}' to #{uri.host}"
+          debug "Send message: '#{encoded_post_data}' to #{uri.host}:#{uri.port}"
           return API_RESPONSE_SUCCESS
         else
           log "SpeakingApps Error: #{ api_response.body if api_response.respond_to?(:body) }"

data/lib/speaking_apps/message_queue.rb

@@ -8,7 +8,7 @@ module SpeakingApps
     attr_accessor :environment
     
     def initialize(environment = nil)
-      @environment = environment
+      @environment = environment.to_s if environment
     end    
     
     def add(message, *attr)
@@ -17,9 +17,9 @@ module SpeakingApps
           :message => message, 
           :tags => attr, 
           :environment => @environment,
-          :token => SpeakingApps::Config.token,
-          :host => SpeakingApps::Config.host,
-          :port => SpeakingApps::Config.port
+          :token => SpeakingApps.token,
+          :host => SpeakingApps.host,
+          :port => SpeakingApps.port.to_s
         })
       end
     end    
@@ -37,7 +37,7 @@ module SpeakingApps
     end
 
     def store_in_remote_service_queue(message_with_options = {})
-#      begin
+     begin
         Timeout::timeout(2) do
           hub_url = URI.parse('http://127.0.0.1:28128/messages')
           response = Net::HTTP.start(hub_url.host, hub_url.port) do |http| 
@@ -45,13 +45,14 @@ module SpeakingApps
           end
           return response == Net::HTTPCreated
        end        
-      # rescue => error
-      #   return false
-      # end
+      rescue => error
+        puts error
+        return false
+      end
     end
     
     def environment_valid? #:nodoc#
-      @environment.nil? || ::SpeakingApps::Config.environments.include?(@environment)
+      @environment.nil? || ::SpeakingApps.environments.include?(@environment.to_sym)
     end    
   end
 end 

data/rails/init.rb

@@ -1 +1 @@
-SpeakingApps.init(RAILS_ENV)
+SpeakingApps.init(RAILS_ENV)

data/spec/lib/speaking_apps/message_queue_spec.rb

@@ -1,13 +1,14 @@
 require File.dirname(__FILE__) + '/../../spec_helper'
-require 'lib/speaking_apps/config'
+require 'lib/speaking_apps'
 require 'lib/speaking_apps/message_queue'
 
 describe 'SpeakingApps::MessageQueue' do
   before(:each) do    
-    SpeakingApps::Config.stub!(:token).and_return(nil)
-
+    SpeakingApps.init
+    SpeakingApps.environments = [ :test ]
+    SpeakingApps.token = 'test'
     @message_queue = SpeakingApps::MessageQueue.new
-    @message_queue.environment = 'test'
+    @message_queue.environment = :test
     @message_queue.stub!(:environment_valid?).and_return(true)    
   end
 
@@ -47,6 +48,6 @@ describe 'SpeakingApps::MessageQueue' do
   end
   
   def message_hash(opts = {})
-    { :environment=>"test", :host=>"speakingapps.com", :port=>"80", :tags=>[], :message=>"", :token=>nil }.merge(opts)
+    { :environment=> 'test', :host=>"speakingapps.com", :port=>"80", :tags=>[], :message=>"", :token=> 'test' }.merge(opts)
   end
 end

data/spec/lib/speaking_apps_spec.rb

@@ -8,12 +8,12 @@ describe SpeakingApps do
     SpeakingApps.stub!(:message_queue).and_return(@mock_message_queue)
   end
   
-  describe '#init' do
+  describe '#configure' do
     it 'should try to load the service daemon' do
       SpeakingApps.stub!(:class_variable_defined?).and_return(false)
       @mock_message_queue.stub!(:environment_valid?).and_return(true)
       SpeakingApps.should_receive(:ensure_existence_of_service_daemon)
-      SpeakingApps.init
+      SpeakingApps.configure { |config| config.token = 'Test' }
     end
   end
   

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: dynamicdudes-speaking-apps
 version: !ruby/object:Gem::Version 
-  version: 1.1.3
+  version: 1.2.0
 platform: ruby
 authors: 
 - rubyphunk
@@ -33,6 +33,16 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 1.1.3
     version: 
+- !ruby/object:Gem::Dependency 
+  name: sinatra
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.9.0.4
+    version: 
 description: The official SpeakingApps Gem. Allows your Rails app (or every other Ruby project) to chat with the http://speakingapps.com logging service.
 email: treas@dynamicdudes.com
 executables: 
@@ -42,7 +52,6 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
-- lib/speaking_apps/config.rb
 - lib/speaking_apps/daemon/control.rb
 - lib/speaking_apps/daemon/queue_service.rb
 - lib/speaking_apps/daemon/remote.rb
@@ -55,7 +64,6 @@ files:
 - VERSION.yml
 - spec/lib
 - spec/lib/speaking_apps
-- spec/lib/speaking_apps/config_spec.rb
 - spec/lib/speaking_apps/daemon
 - spec/lib/speaking_apps/daemon/queue_service_spec.rb
 - spec/lib/speaking_apps/daemon/remote_spec.rb

data/lib/speaking_apps/config.rb

@@ -1,58 +0,0 @@
-module SpeakingApps
-  
-  # Use <b>SpeakingApps::Config</b> to setup your http://SpeakingApps.com API access.
-  #
-  # Please note: You must set the token in order to use the API.
-  # Don't know your token? Login to your account on http://youraccount.speakingapps.com (or get a new one),
-  # select your project and open 'Settings'.
-  #
-  # Place the configuration wherever you want. In a Rails app you would typically add these lines
-  # under <tt>config/environment</tt> or <tt>config/initializers/</tt>.
-  
-  class Config
-    
-    # Configure which Project-Token to use.
-    #
-    # <tt>SpeakingApps::Config.token = 'your-api-token'</tt>
-    def self.token=(new_token)
-      @@_token = new_token
-    end
-    
-    def self.token  #:nodoc:
-      class_variable_defined?(:@@_token) ? @@_token : nil
-    end    
-
-    # Set the environment(s) in which SpeakingApps#log should be active. Defaults to: ['production']
-    #
-    # <tt>SpeakingApps::Config.environments = ['staging', 'production']</tt>
-    def self.environments=(new_environments)
-      @@_environments = new_environments
-    end
-    
-    def self.environments #:nodoc:
-      class_variable_defined?(:@@_environments) ? @@_environments : ['production']
-    end
-  
-    def self.host=(new_host) #:nodoc:
-      @@_host = new_host
-    end
-    
-    def self.host #:nodoc:
-      class_variable_defined?(:@@_host) ? @@_host : 'speakingapps.com'
-    end
-    
-    def self.port=(new_port) #:nodoc:
-      @@_port = new_port
-    end
-    
-    def self.port #:nodoc:
-      class_variable_defined?(:@@_host) ? @@_port : '80'
-    end
-    
-    def self.clear! #:nodoc:
-      class_variables.each do |v|
-        remove_class_variable v.intern rescue true
-      end
-    end
-  end
-end

data/spec/lib/speaking_apps/config_spec.rb

@@ -1,22 +0,0 @@
-require File.dirname(__FILE__) + '/../../spec_helper'
-require 'lib/speaking_apps/config'
-
-describe SpeakingApps::Config do
-  before(:each) do
-    SpeakingApps::Config.clear!
-  end
-  
-  it 'should allow setting the token' do
-    SpeakingApps::Config.token = 'test'
-    SpeakingApps::Config.token.should eql('test')
-  end
-  
-  it 'should allow defining environments' do
-    SpeakingApps::Config.environments = ['development', 'production']
-    SpeakingApps::Config.environments.should eql(['development', 'production'])
-  end
-  
-  it 'should use the default environment "production" if nothing was set' do
-    SpeakingApps::Config.environments.should eql(['production'])
-  end
-end