beaconpush 0.0.1 → 0.0.2

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Jakub Kuźma
+
+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,51 @@
+= Beaconpush
+
+Beaconpush gem provides easy access to the {Beacon push service}[http://beaconpush.com/] from your application.
+
+== Usage
+
+  require "beaconpush"
+
+  # You may want to put these two lines inside of an initializer in
+  # your Rails application
+  Beaconpush.key = "ad819983"
+  Beaconpush.secret = "..."
+
+  # Beaconpush is ready to use now!
+
+  # Fetches the number of online users
+  Beaconpush.users_count
+  # => 2
+
+  # Checks if the user is online at the moment
+  Beaconpush.user_online?("alice")
+  # => false
+
+  # Sends the given message to the user
+  Beaconpush.user_message("bob", "Hello Bob!")
+
+  # Fetches the list of online users in the given channel
+  Beaconpush.channel_users("myfirstchannel")
+  # => ["bob"]
+
+  # Sends the given message to the channel
+  Beaconpush.channel_message("myfirstchannel", :message => "Channel message!", :severity => "important")
+
+  # Forces the user to disconnect
+  Beaconpush.user_logout("bob")
+
+  # You can also use multiple Beacon accounts in a single application
+  client1 = Beaconpush::Client.new(:key => "da10749525", :secret => "...")
+  client2 = Beaconpush::Client.new(:key => "bb19021573", :secret => "...")
+  client1.users_count
+  # => 0
+  client2.users_count
+  # => 4
+
+== Installation
+
+  gem install beaconpush
+
+== Copyright
+
+Copyright (c) 2010 Jakub Kuźma. Released on the MIT license (see LICENSE[http://github.com/qoobaa/beaconpush/raw/master/LICENSE] for details).

data/lib/beaconpush/client.rb

@@ -1,10 +1,10 @@
 module Beaconpush
   class Client
-    attr_accessor :api_key, :secret_key, :version, :host, :port
+    attr_accessor :key, :secret, :version, :host, :port
 
     def initialize(options)
-      self.api_key = options.fetch(:api_key, Beaconpush.api_key) || raise(ArgumentError, "No API key given")
-      self.secret_key = options.fetch(:secret_key, Beaconpush.secret_key) || raise(ArgumentError, "No secret key given")
+      self.key = options.fetch(:key, Beaconpush.key) || raise(ArgumentError, "No key given")
+      self.secret = options.fetch(:secret, Beaconpush.secret) || raise(ArgumentError, "No secret given")
       self.version = options.fetch(:version, Beaconpush.version) || raise(ArgumentError, "No API version given")
       self.host = options.fetch(:host, Beaconpush.host) || raise(ArgumentError, "No Beacon host given")
       self.port = options.fetch(:port, Beaconpush.port) || raise(ArgumentError, "No Beacon port given")
@@ -44,7 +44,7 @@ module Beaconpush
     end
 
     def request(method, command, body = nil)
-      path = "/api/#{version}/#{api_key}#{URI.encode(command)}"
+      path = "/api/#{version}/#{key}#{URI.encode(command)}"
 
       request = Net::HTTPGenericRequest.new(method.to_s.upcase, !!body, method.to_s.upcase != "HEAD", path)
 
@@ -53,7 +53,7 @@ module Beaconpush
         request.content_length = body.size
       end
 
-      request["X-Beacon-Secret-Key"] = secret_key
+      request["X-Beacon-Secret-Key"] = secret
 
       response = http.request(request)
 

data/lib/beaconpush/version.rb

@@ -1,3 +1,3 @@
 module Beaconpush
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/beaconpush.rb

@@ -8,7 +8,7 @@ require "beaconpush/response_error"
 module Beaconpush
   class << self
     extend Forwardable
-    attr_accessor :api_key, :secret_key
+    attr_accessor :key, :secret
     attr_writer :version, :host, :port
     def_delegators :client, :users_count, :user_online?, :user_logout, :user_message, :channel_message, :channel_users
 
@@ -25,7 +25,7 @@ module Beaconpush
     end
 
     def client
-      @client ||= Client.new(:api_key => api_key, :secret_key => secret_key, :version => version, :host => host, :port => port)
+      @client ||= Client.new(:key => key, :secret => secret, :version => version, :host => host, :port => port)
     end
   end
 end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - "Jakub Ku\xC5\xBAma"
@@ -31,6 +31,8 @@ files:
 - .gitignore
 - Gemfile
 - Gemfile.lock
+- LICENSE
+- README.rdoc
 - Rakefile
 - beaconpush.gemspec
 - lib/beaconpush.rb