dimma 1.0.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,23 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC
+.yardoc
+doc

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Kim Burgestrand
+
+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.markdown

@@ -0,0 +1,29 @@
+What is Dimma?
+==============
+Dimma is a Ruby library aimed to create a simple interface to [Beacons REST API](http://www.beaconpush.com/), built on top of the sweet [REST Client](http://github.com/archiloque/rest-client).
+
+How do I use it?
+----------------
+Excellent question! This is how:
+
+    # Set up the session.
+    beacon = Dimma.new(API_KEY, SECRET_KEY)
+    
+    # Send a message to all users in the default channel.
+    beacon.message "We now have a total of #{beacon.users} users online!"
+    
+    # Send a message to all users in the “chunky” channel.
+    chunky = beacon.channel "chunky"
+    chunky.message "Chunky bacon!"
+    # Spit out all the channel users in the “chunky” channel.
+    chunky.message "Current users in “chunky” channel: #{chunky.users.map(&:name).join ', '}"
+    
+    # Send a message to a specific user if she is online.
+    candy = beacon.user "godisnappen88"
+    candy.message 'A/S/L?' if candy.online?
+
+Really? Yeah, really! For more advanced usage I suggest you [read the documentation](http://rdoc.info/projects/Burgestrand/Dimma).
+
+Miscellaneous notes
+-------------------
+- Dimma uses [Semantic Versioning](http://semver.org/) as of version v1.0.0!

data/Rakefile

@@ -0,0 +1,47 @@
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "dimma"
+    gem.summary = "A Ruby library for the Beacon REST API"
+    gem.email = "kim@burgestrand.se"
+    gem.homepage = "http://github.com/Burgestrand/Dimma"
+    gem.authors = ["Kim Burgestrand"]
+    gem.license = "X11 License"
+    gem.add_dependency "rest-client"
+    gem.add_dependency "json"
+    gem.add_development_dependency "webmock"
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    gem.add_development_dependency "yard", ">= 0"
+    gem.required_ruby_version = '>= 1.8.7'
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new
+rescue LoadError
+  task :yardoc do
+    abort "YARD is not available. In order to run yardoc, you must: sudo gem install yard"
+  end
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/dimma.gemspec

@@ -0,0 +1,68 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{dimma}
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Kim Burgestrand"]
+  s.date = %q{2010-07-05}
+  s.email = %q{kim@burgestrand.se}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.markdown"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.markdown",
+     "Rakefile",
+     "VERSION",
+     "dimma.gemspec",
+     "lib/Dimma.rb",
+     "spec/dimma_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/Burgestrand/Dimma}
+  s.licenses = ["X11 License"]
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.required_ruby_version = Gem::Requirement.new(">= 1.8.7")
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{A Ruby library for the Beacon REST API}
+  s.test_files = [
+    "spec/dimma_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<rest-client>, [">= 0"])
+      s.add_runtime_dependency(%q<json>, [">= 0"])
+      s.add_development_dependency(%q<webmock>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_development_dependency(%q<yard>, [">= 0"])
+    else
+      s.add_dependency(%q<rest-client>, [">= 0"])
+      s.add_dependency(%q<json>, [">= 0"])
+      s.add_dependency(%q<webmock>, [">= 0"])
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_dependency(%q<yard>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rest-client>, [">= 0"])
+    s.add_dependency(%q<json>, [">= 0"])
+    s.add_dependency(%q<webmock>, [">= 0"])
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    s.add_dependency(%q<yard>, [">= 0"])
+  end
+end
+

data/lib/Dimma.rb

@@ -0,0 +1,135 @@
+require 'delegate'
+require 'rest-client'
+require 'json'
+
+# See http://beaconpush.com/guide for specification details.
+#
+module Dimma
+  # The Beacon API (http://beaconpush.com/guide/rest-api) version Dimma conforms to.
+  API_VERSION = "1.0.0"
+  
+  # @param (see Session#initialize)
+  # @return (see Session#initialize)
+  # @see Session#initialize
+  def Dimma.new(*args)
+    Session.new *args
+  end
+
+  # Missing method calls are delegated to the underlying RestClient::Resource
+  class Session < SimpleDelegator
+    # Initialize the Beacon API resource; you get both your API key and secret key from http://beaconpush.com/account/settings.
+    #
+    # @example
+    #   # Specify that no requests must take longer than 10 seconds.
+    #   dimma = Dimma::Session.new "key", "secret", :timeout => 10
+    #
+    # @param [#to_s] key API key.
+    # @param [nil, #to_s] secret Secret key. Set to nil if you have turned off authentication.
+    # @param [Hash] options (see RestClient#initialize)
+    def initialize(key, secret = nil, options = {})
+      url = "http://api.beaconpush.com/#{Dimma::API_VERSION}/#{key.to_s}/"
+      options[:headers] ||= {}
+      options[:headers].merge!({"X-Beacon-Secret-Key" => secret.to_s}) unless secret.nil?
+      __setobj__ RestClient::Resource.new(url, options)
+    end
+    
+    # Retrieve number of online users.
+    #
+    # @return [Fixnum]
+    def users
+      JSON.parse(self['users'].get.body)["online"]
+    end
+
+    # Send a message to the 'default' channel.
+    #
+    # @param (see Channel#message)
+    # @return (see Channel#message)
+    # @see Channel#message
+    def message(message)
+      channel.message(message)
+    end
+    
+    # Retrieve a user by name, bound to this Session.
+    #
+    # @param [#to_s] name
+    # @return (see Session#initialize)
+    def user(name)
+      User.new(name, __getobj__)
+    end
+    
+    # Retrieve a channel by name, bound to this Session.
+    # 
+    # @param [#to_s] name
+    # @return (see Channel#initialize)
+    def channel(name = 'default')
+      Channel.new(name, __getobj__)
+    end
+  end
+  
+  # Missing method calls are delegated to the underlying RestClient::Resource
+  class User < SimpleDelegator
+    # @return [String]
+    attr_reader :name
+    
+    # Create a new User resource.
+    #
+    # @param [#to_s] name
+    # @param [RestClient::Resource] resource An object conformant with the RestClient API.
+    def initialize(name, resource)
+      __setobj__ resource["users/#{@name = name.to_s}"]
+    end
+
+    # True if the user is online.
+    #
+    # @return [Boolean]
+    def online?
+      get.code == 200 rescue false
+    end
+
+    # Force-logout the user.
+    #
+    # @return [RestClient::Response]
+    def logout
+      delete
+    end
+
+    # Send a message to the user.
+    #
+    # @param [#to_json] message Data to send to the user.
+    # @return [RestClient::Response]
+    # @raise [RestClient::Exception]
+    def message(message)
+      post message.to_json
+    end
+  end
+  
+  # Missing method calls are delegated to the underlying RestClient::Resource
+  class Channel < SimpleDelegator
+    # @return [String]
+    attr_reader :name
+    
+    # Create a new Channel resource.
+    #
+    # @param [#to_s] name
+    # @param [RestClient::Resource] resource An object conformant with the RestClient API.
+    def initialize(name, resource)
+      __setobj__ resource["channels/#{@name = name.to_s}"]
+    end
+
+    # Sends a message to all users in the channel.
+    #
+    # @param [#to_json] message Data to send to the channel.
+    # @return [RestClient::Response]
+    # @raise [RestClient::Exception]
+    def message(message)
+      post message.to_json
+    end
+
+    # Retrieve all users in the channel.
+    #
+    # @return [Array<User>] Array of users.
+    def users
+      JSON.parse(get.body)["users"].map { |user| User.new(user, __getobj__) }
+    end
+  end
+end

data/spec/dimma_spec.rb

@@ -0,0 +1,72 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe Dimma do
+  before do
+    @url ||= "http://api.beaconpush.com/#{Dimma::API_VERSION}/resource/"
+    @obj = Dimma.new("resource")
+
+    # Total user count
+    stub_request(:get, @url + 'users').to_return(:body => {:online => 10}.to_json)
+    
+    # Channel message posting
+    stub_request(:get, @obj.channel.url).to_return(:body => {:users => ['Kim']}.to_json)
+    stub_request(:post, @obj.channel.url).
+      with(:body => 'Message'.to_json).to_return(:body => {:messages_sent => 1}.to_json)
+      
+    # User API
+    @user = @obj.user 'Kim'
+    stub_request(:get, @user.url).to_return(:headers => {:code => 200})
+    stub_request(:post, @user.url).
+      with(:body => 'Message'.to_json).to_return(:body => {:messages_sent => 1}.to_json)
+    stub_request(:delete, @user.url).to_return(:headers => {:code => 204})
+  end
+  
+  it "can retrieve a total usercount" do
+    @obj.users
+    WebMock.should have_requested(:get, @obj['users'].url)
+  end
+  
+  it "can send messages to default channel" do
+    @obj.message 'Message'
+    WebMock.should have_requested(:post, @obj.channel.url).with(:body => 'Message'.to_json)
+  end
+  
+  describe Dimma::User do
+    it "should have a name" do
+      @user.name.should == 'Kim'
+    end
+    
+    it "should be online" do
+      @user.online?.should be true
+      WebMock.should have_requested(:get, @user.url)
+    end
+    
+    it "can be logged out by force" do
+      @user.logout
+      WebMock.should have_requested(:delete, @user.url)
+    end
+    
+    it "can be sent messages" do
+      @user.message 'Message'
+      WebMock.should have_requested(:post, @user.url).with(:body => 'Message'.to_json)
+    end
+  end
+  
+  describe Dimma::Channel do
+    it "should have a name" do
+      @obj.channel.name.should == "default"
+    end
+    
+    it "can be sent messages" do
+      channel = @obj.channel
+      channel.message 'Message'
+      WebMock.should have_requested(:post, channel.url).with(:body => 'Message'.to_json)
+    end
+    
+    it "should have a list of users" do
+      channel = @obj.channel
+      channel.users.map(&:name).should == ['Kim']
+      WebMock.should have_requested(:get, channel.url)
+    end
+  end
+end

data/spec/spec.opts

@@ -0,0 +1,2 @@
+--color
+-fs

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$:.unshift File.dirname(__FILE__)
+$:.unshift File.expand_path('../../lib', __FILE__)
+require 'dimma'
+require 'spec'
+require 'webmock/rspec'
+
+Spec::Runner.configure do |config|
+  config.include WebMock
+end

metadata

@@ -0,0 +1,152 @@
+--- !ruby/object:Gem::Specification 
+name: dimma
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Kim Burgestrand
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-07-05 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rest-client
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: webmock
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: yard
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id005
+description: 
+email: kim@burgestrand.se
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.markdown
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.markdown
+- Rakefile
+- VERSION
+- dimma.gemspec
+- lib/Dimma.rb
+- spec/dimma_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/Burgestrand/Dimma
+licenses: 
+- X11 License
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 57
+      segments: 
+      - 1
+      - 8
+      - 7
+      version: 1.8.7
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A Ruby library for the Beacon REST API
+test_files: 
+- spec/dimma_spec.rb
+- spec/spec_helper.rb