firering 0.1.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Emmanuel Oga
+
+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,83 @@
+= firering
+
+Campfire API interface powered by EventMachine and Yajl.
+
+  require 'firering'
+
+  Firering.subdomain = "subdomain"
+  Firering.token     = "token"
+
+  EM.run do
+    Firering.rooms do |rooms|
+      rooms.each do |room|
+        if room.name == "RoomName"
+
+          puts "Joining #{room.name}"
+
+          Firering.room_join(room.id) do
+            Firering.stream(room.id) do |message|
+
+              if message.from_user?
+                Firering.user(message.user_id) do |user|
+                  puts "( #{user.name} ) #{message.body}"
+                end
+              else
+                puts message.body if message.body.to_s !~ /^\s*$/
+              end
+
+            end
+          end
+
+        end
+      end
+    end
+
+    trap("INT") { EM.stop }
+  end
+
+= campf-notify
+
+The gem bundles an executable script for spawning libnotify powered notifications.
+To be able to use it, check your distro package repositories for the apropriate
+package containing the "notify-send" command line utility. In the case of archlinux,
+the package name is "libnotify".
+
+The script needs the following environment variables in place:
+
+  CAMPFIRE_SUBDOMAIN
+  CAMPFIRE_TOKEN
+
+Once the variables are set, run the script as follows:
+
+  campf-notify room-name /path/to/an/icon.png
+
+And watch the lovely notifications each time something is posted to a room.
+
+== Running the specs
+
+For running the specs, I opted for running a sinatra application for serving
+the fixture data. The server runs automatically when "rake spec" is executed,
+it runs on the standard sinatra port (4567), so you should make sure that
+port is free when running the specs.
+
+For more details take a look at spec/fixtures/load_server.rb file.
+
+== TODO
+
+* Better API documentation
+* Post files to a room
+* Retrieve recently uploaded files
+
+== Note on Patches/Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (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.
+
+== Copyright
+
+Copyright (c) 2010 Emmanuel Oga. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,143 @@
+require 'rubygems'
+require 'rake'
+require 'date'
+
+#############################################################################
+#
+# Helper functions
+#
+#############################################################################
+
+def name
+  @name ||= Dir['*.gemspec'].first.split('.').first
+end
+
+def version
+  line = File.read("lib/#{name}.rb")[/^\s*VERSION\s*=\s*.*/]
+  line.match(/.*VERSION\s*=\s*['"](.*)['"]/)[1]
+end
+
+def date
+  Date.today.to_s
+end
+
+def rubyforge_project
+  name
+end
+
+def gemspec_file
+  "#{name}.gemspec"
+end
+
+def gem_file
+  "#{name}-#{version}.gem"
+end
+
+def replace_header(head, header_name)
+  head.sub!(/(\.#{header_name}\s*= ').*'/) { "#{$1}#{send(header_name)}'"}
+end
+
+#############################################################################
+#
+# Standard tasks
+#
+#############################################################################
+
+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 :default => :spec
+
+desc "Open an irb session preloaded with this library"
+task :console do
+  sh "irb -I ./lib/ -rubygems -r ./lib/#{name}.rb"
+end
+
+#############################################################################
+#
+# Custom tasks (add your own tasks here)
+#
+#############################################################################
+
+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
+
+#############################################################################
+#
+# Packaging tasks
+#
+#############################################################################
+
+task :release => :build do
+  unless `git branch` =~ /^\* master$/
+    puts "You must be on the master branch to release!"
+    exit!
+  end
+  sh "git commit --allow-empty -a -m 'Release #{version}'"
+  sh "git tag v#{version}"
+  sh "git push origin master"
+  sh "git push v#{version}"
+  sh "gem push pkg/#{name}-#{version}.gem"
+end
+
+task :build => :gemspec do
+  sh "mkdir -p pkg"
+  sh "gem build #{gemspec_file}"
+  sh "mv #{gem_file} pkg"
+end
+
+task :gemspec => :validate do
+  # read spec file and split out manifest section
+  spec = File.read(gemspec_file)
+  head, manifest, tail = spec.split("  # = MANIFEST =\n")
+
+  # replace name version and date
+  replace_header(head, :name)
+  replace_header(head, :version)
+  replace_header(head, :date)
+  #comment this out if your rubyforge_project has a different name
+  replace_header(head, :rubyforge_project)
+
+  # determine file list from git ls-files
+  files = `git ls-files`.
+    split("\n").
+    sort.
+    reject { |file| file =~ /^\./ }.
+    reject { |file| file =~ /^(rdoc|pkg)/ }.
+    map { |file| "    #{file}" }.
+    join("\n")
+
+  # piece file back together and write
+  manifest = "  s.files = %w[\n#{files}\n  ]\n"
+  spec = [head, manifest, tail].join("  # = MANIFEST =\n")
+  File.open(gemspec_file, 'w') { |io| io.write(spec) }
+  puts "Updated #{gemspec_file}"
+end
+
+task :validate do
+  libfiles = Dir['lib/*'] - ["lib/#{name}.rb", "lib/#{name}"]
+  unless libfiles.empty?
+    puts "Directory `lib` should only contain a `#{name}.rb` file and `#{name}` dir."
+    exit!
+  end
+  unless Dir['VERSION*'].empty?
+    puts "A `VERSION` file at root level violates Gem best practices."
+    exit!
+  end
+end

data/bin/campf-notify

@@ -0,0 +1,56 @@
+#!/usr/bin/env ruby
+
+require 'firering'
+require 'shellwords'
+
+Firering.subdomain = ENV["CAMPFIRE_SUBDOMAIN"].to_s
+Firering.token     = ENV["CAMPFIRE_TOKEN"].to_s
+
+room_name = ARGV[0].to_s
+icon_path = ARGV[1].to_s
+
+if Firering.subdomain =~ /^\s*$/ || Firering.token =~ /^\s*$/ || room_name =~ /^\s*$/ || !File.exists?(icon_path)
+  puts "USAGE: campf-notify room-name notify-send-icon-path"
+  puts
+  puts "Icon path #{icon_path} is incorrect\n" unless File.exists?(icon_path)
+  puts "Room name #{room_name} is missing" unless room_name !~ /^\s*$/
+
+  puts "The following environment variables are needed: "
+  puts
+  puts "CAMPFIRE_SUBDOMAIN: #{Firering.subdomain}"
+  puts "CAMPFIRE_TOKEN:     #{Firering.token}"
+  puts
+  exit
+else
+  puts "connecting to #{Firering.subdomain}.#{Firering::HTTP.host}"
+end
+
+EM.run do
+  Firering.rooms do |rooms|
+    rooms.each do |room|
+      if room.name == room_name
+
+        puts "Joining #{room.name}"
+
+        Firering.room_join(room.id) do
+          Firering.stream(room.id) do |message|
+
+            if message.from_user?
+              Firering.user(message.user_id) do |user|
+                m = "( #{user.name} ) #{message.body}"
+                system("notify-send -i #{icon_path.shellescape} -t 10000 Campfire #{m.shellescape}")
+              end
+            else
+              m = message.body.to_s
+              system("notify-send -i #{icon_path.shellescape} -t 10000 Campfire #{m.shellescape}") if m !~ /^\s*$/
+            end
+
+          end
+        end
+
+      end
+    end
+  end
+
+  trap("INT") { EM.stop }
+end

data/examples/authenticate.rb

@@ -0,0 +1,22 @@
+require 'firering'
+
+puts "If you prefer it, you can authenticate your user with u/p instead of the campfire token."
+
+print "Enter subdomain: "
+subdomain = gets.chomp
+
+print "Enter user: "
+user = gets.chomp
+
+print "Enter password: "
+password = gets.chomp
+
+EM.run do
+  Firering.authenticate(subdomain, user, password) do |user|
+
+    puts "Token for user #{user.name} is #{user.token}"
+
+    EM.stop
+
+  end
+end

data/examples/events.rb

@@ -0,0 +1,39 @@
+require 'firering'
+
+Firering.subdomain = ENV["CAMPFIRE_SUBDOMAIN"]
+Firering.token     = ENV["CAMPFIRE_TOKEN"]
+
+EM.run do
+  Firering.rooms do |rooms|
+    rooms.each do |room|
+      if room.name == "test2"
+        Firering.room_join(room.id) do
+          Firering.stream(room.id) do |message|
+
+            case
+            when message.advertisement?   then puts "Handle Ad"
+            when message.allow_guests?    then puts "Handle Allow Guests"
+            when message.disallow_guests? then puts "Handle Disallow Guests"
+            when message.idle?            then puts "Handle Idle"
+            when message.kick?            then puts "Handle Kick"
+            when message.leave?           then puts "Handle Leave"
+            when message.paste?           then puts "Handle Paste"
+            when message.sound?           then puts "Handle Sound"
+            when message.system?          then puts "Handle System"
+            when message.text?            then puts "Handle Text"
+            when message.timestamp?       then puts "Handle Timestamp"
+            when message.topic_change?    then puts "Handle Topic Change"
+            when message.unidle?          then puts "Handle Un Idle"
+            when message.unlock?          then puts "Handle Unlock"
+            when message.upload?          then puts "Handle Upload"
+            end
+
+            puts message.to_s
+          end
+        end
+      end
+    end
+  end
+
+  trap("INT") { EM.stop }
+end

data/examples/recent_messages.rb

@@ -0,0 +1,43 @@
+require 'firering'
+
+Firering.subdomain = ENV["CAMPFIRE_SUBDOMAIN"]
+Firering.token     = ENV["CAMPFIRE_TOKEN"]
+
+EM.run do
+  Firering.rooms do |rooms|
+
+    rooms.each do |room|
+      puts "Users in room #{room.name} (#{room.topic})"
+
+      if room.users.empty?
+        puts "  empty (locked: #{room.locked?})"
+      else
+        room.users.each do |u|
+          puts "  #{ u.name }. Admin: #{ u.admin? }"
+        end
+      end
+
+      if room.locked?
+        puts "  can't get recent messages in a locked room'"
+      else
+        Firering.room_recent_messages(room.id) do |messages|
+
+          puts "-" * 80
+          puts "recent message on #{room.name}"
+          puts "-" * 80
+
+          messages.slice(0, 4).each do |m|
+            puts "\n  (#{m.user_id})"
+
+            m.body.to_s.split("\n").each do |chunk|
+              puts "  > #{chunk}"
+            end
+          end
+        end
+      end
+
+    end
+  end
+
+  trap("INT") { EM.stop }
+end

data/examples/rooms.rb

@@ -0,0 +1,24 @@
+require 'firering'
+
+Firering.subdomain = ENV["CAMPFIRE_SUBDOMAIN"]
+Firering.token     = ENV["CAMPFIRE_TOKEN"]
+
+EM.run do
+  Firering.rooms do |rooms|
+
+    rooms.each do |room|
+      puts "Users in room #{room.name}"
+
+      if room.users.empty?
+        puts "  empty (locked: #{room.locked?})"
+      else
+        room.users.each do |u|
+          puts "  #{ u.name }"
+        end
+      end
+
+    end
+  end
+
+  trap("INT") { EM.stop }
+end

data/examples/update_room.rb

@@ -0,0 +1,33 @@
+require 'firering'
+
+Firering.subdomain = ENV["CAMPFIRE_SUBDOMAIN"]
+Firering.token     = ENV["CAMPFIRE_TOKEN"]
+
+ROOM = "test2"
+
+EM.run do
+  Firering.rooms do |rooms|
+    rooms.each do |room|
+      if room.name == ROOM
+        Firering.room_join(room.id) do
+
+          Firering.update_room(room.id, "topic" => "test test test") do |response|
+            puts "  * Updating topic: "
+            puts response.response_header.status
+          end
+
+          Firering.text(room.id, "hola") do
+            puts "texted"
+          end
+
+          Firering.paste(room.id, "hola\nmundo") do
+            puts "pasted"
+          end
+
+        end
+      end
+    end
+  end
+
+  trap("INT") { EM.stop }
+end

data/firering.gemspec

@@ -0,0 +1,99 @@
+Gem::Specification.new do |s|
+  s.specification_version = 2 if s.respond_to? :specification_version=
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.rubygems_version = '1.3.5'
+
+  s.name              = 'firering'
+  s.version           = '0.1.0'
+  s.date              = '2010-05-30'
+  s.rubyforge_project = 'firering'
+
+  s.summary     = "Campfire API interface powered by EventMachine and Yajl."
+  s.description = "Campfire API interface powered by EventMachine and Yajl."
+
+  s.authors  = ["Emmanuel Oga"]
+  s.email    = 'EmmanuelOga@gmail.com'
+  s.homepage = 'http://github.com/EmmanuelOga/firering'
+
+  s.require_paths = %w[lib]
+
+  s.executables = ["campf-notify"]
+  s.default_executable = 'campf-notify'
+
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.extra_rdoc_files = %w[README.rdoc LICENSE]
+
+  s.add_dependency('eventmachine', [">= 0.12.10"])
+  s.add_dependency('em-http-request', [">= 0.2.7"])
+  s.add_dependency('yajl-ruby', [">= 0.7.6"])
+
+  s.add_development_dependency('rspec', [">= 1.3.0"])
+  s.add_development_dependency('sinatra', [">= 1.0.0"])
+
+  # = MANIFEST =
+  s.files = %w[
+    LICENSE
+    README.rdoc
+    Rakefile
+    bin/campf-notify
+    examples/authenticate.rb
+    examples/events.rb
+    examples/recent_messages.rb
+    examples/rooms.rb
+    examples/update_room.rb
+    firering.gemspec
+    lib/firering.rb
+    lib/firering/data.rb
+    lib/firering/data/message.rb
+    lib/firering/data/room.rb
+    lib/firering/data/upload.rb
+    lib/firering/data/user.rb
+    lib/firering/http.rb
+    lib/firering/requests.rb
+    lib/firering/streaming.rb
+    spec/firering/data_spec.rb
+    spec/firering/requests_spec.rb
+    spec/fixtures/headers/delete_messages_ID_star.json
+    spec/fixtures/headers/get_room_ID.json
+    spec/fixtures/headers/get_room_ID_live.json
+    spec/fixtures/headers/get_room_ID_recent.json
+    spec/fixtures/headers/get_room_ID_transcript.json
+    spec/fixtures/headers/get_room_ID_transcript_ID_ID_ID.json
+    spec/fixtures/headers/get_room_ID_uploads.json
+    spec/fixtures/headers/get_rooms.json
+    spec/fixtures/headers/get_search_harmless.json
+    spec/fixtures/headers/get_users_ID.json
+    spec/fixtures/headers/get_users_me.json
+    spec/fixtures/headers/post_messages_ID_star.json
+    spec/fixtures/headers/post_room_ID_join.json
+    spec/fixtures/headers/post_room_ID_leave.json
+    spec/fixtures/headers/post_room_ID_speak.json
+    spec/fixtures/headers/post_room_ID_unlock.json
+    spec/fixtures/headers/put_room_ID.json
+    spec/fixtures/json/delete_messages_ID_star.json
+    spec/fixtures/json/get_room_ID.json
+    spec/fixtures/json/get_room_ID_live.json
+    spec/fixtures/json/get_room_ID_recent.json
+    spec/fixtures/json/get_room_ID_transcript.json
+    spec/fixtures/json/get_room_ID_transcript_ID_ID_ID.json
+    spec/fixtures/json/get_room_ID_uploads.json
+    spec/fixtures/json/get_rooms.json
+    spec/fixtures/json/get_search_harmless.json
+    spec/fixtures/json/get_users_ID.json
+    spec/fixtures/json/get_users_me.json
+    spec/fixtures/json/post_messages_ID_star.json
+    spec/fixtures/json/post_room_ID_join.json
+    spec/fixtures/json/post_room_ID_leave.json
+    spec/fixtures/json/post_room_ID_lock.json
+    spec/fixtures/json/post_room_ID_speak.json
+    spec/fixtures/json/post_room_ID_unlock.json
+    spec/fixtures/json/put_room_ID.json
+    spec/fixtures/load_server.rb
+    spec/fixtures/retrieve.rb
+    spec/fixtures/server.rb
+    spec/spec_helper.rb
+  ]
+  # = MANIFEST =
+
+  s.test_files = s.files.select { |path| path =~ /^spec/ }
+end

data/lib/firering/data/message.rb

@@ -0,0 +1,29 @@
+module Firering
+  class Message < Firering::Data
+    key :id, :room_id, :user_id, :body, :created_at, :type
+
+    MESSAGE_TYPES = %w[
+      TextMessage PasteMessage SoundMessage AdvertisementMessage
+      AllowGuestsMessage DisallowGuestsMessage IdleMessage KickMessage
+      LeaveMessage SystemMessage TimestampMessage TopicChangeMessage
+      UnidleMessage UnlockMessage UploadMessage
+    ]
+
+    # txs activesupport
+    underscore = proc do |word|
+      word.to_s.gsub(/::/, '/').gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').gsub(/([a-z\d])([A-Z])/,'\1_\2').tr("-", "_").downcase
+    end
+
+    MESSAGE_TYPES.each do |message_type|
+      current_type = (message_type =~ /(.+)Message/) && $1
+      define_method("#{underscore[current_type]}?") do
+        type == message_type
+      end
+    end
+
+    def from_user?
+      !user_id.nil? && (!user_id.instance_of?(String) || user_id !~ /~\s*$/)
+    end
+
+  end
+end

data/lib/firering/data/room.rb

@@ -0,0 +1,13 @@
+module Firering
+  class Room < Firering::Data
+    key :id, :name, :topic, :membership_limit, :full, :open_to_guests, :active_token_value, :updated_at, :created_at, :users, :locked
+
+    alias_method :locked?, :locked
+    alias_method :full?, :full
+    alias_method :open_to_guests?, :open_to_guests
+
+    def users
+      @users ||= (super || []).map { |u| Firering::User.new(u, false) }
+    end
+  end
+end

data/lib/firering/data/upload.rb

@@ -0,0 +1,5 @@
+module Firering
+  class Upload < Firering::Data
+    key :id, :name, :room_id, :user_id, :byte_size, :content_type, :full_url, :created_at
+  end
+end

data/lib/firering/data/user.rb

@@ -0,0 +1,16 @@
+module Firering
+  class User  < Firering::Data
+    key :id, :name, :email_address, :admin, :created_at, :type, :api_auth_token
+
+    alias_method :token, :api_auth_token
+    alias_method :admin?, :admin
+
+    def member?
+      type == "Member"
+    end
+
+    def gest?
+      type == "Guest"
+    end
+  end
+end

data/lib/firering/data.rb

@@ -0,0 +1,35 @@
+module Firering
+  class Data
+
+    # generates methods to access the data stored in the @data Hash
+    def self.key(*keys)
+      methods = keys.map do |key|
+        <<-CODE
+          def #{key}
+            @data[#{key.to_sym.inspect}]
+          end
+        CODE
+      end
+
+      include(Module.new do
+        module_eval methods.join("\n"), __FILE__, __LINE__
+      end)
+    end
+
+    # data is a hash or a json encoded hash (String)
+    # base_key if present is the main data key on the hash.
+    def initialize(data, base_key = nil)
+      @data = data.is_a?(Hash) ? data : Yajl::Parser.parse(data, :symbolize_keys => true)
+      @data = @data[base_key] if base_key
+
+      @data.each do |key, val|
+        @data[key] = Date.parse(val) rescue val if key.to_s =~ /(_at|_on)$/
+      end
+    end
+
+    def inspect
+      "<#{self.class.name} #{@data.inspect}>"
+    end
+
+  end
+end