tinder 1.3.1 → 1.10.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 21c0b81e4f63a6db27ad0ba806c08443314a4ae0
+  data.tar.gz: 41cfc4284a986df69e5f7d5fac9d11347db83afe
+SHA512:
+  metadata.gz: 8f08b0ac436ed01136ba1234eb5cd58b215efe50e50d6adc87924a31a673d962fbc0d07a2def1400cc4399b179b8704949d7076e7f6bf2a0a3893fefd374922b
+  data.tar.gz: 8afb11d4a1572c15382ea75b6b69e2ed10b8ab26ee72f9189cd34ea92cf8ba7d8bf2e88730e5d43246c594c32a56d1a1d32248bdb989e1a8f285bd66bf2979d4

data/.gitignore

@@ -1,3 +1,6 @@
-pkg
-rdoc
-test/remote/credentials.rb
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+.rvmrc
+.ruby-version

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+rvm:
+  - rbx-2
+  - jruby-19mode
+  - 1.9.3
+  - 2.0.0
+  - 2.1
+only:
+  - master
+notifications:
+  disabled: true

data/CHANGELOG.txt

@@ -1,3 +1,57 @@
+1.10.1 - 2014-12-01
+* Loosen hashie dependency
+
+1.10.0 - 2014-08-06
+* Update Faraday dependency
+* Loosen mime-type dependency
+
+1.9.4 - 2014-02-24
+* Fix typos in MIT licence
+* Add Campfire#presence to get a list of rooms in which you are present
+
+1.9.3 - 2013-09-06
+* OAuth support
+
+1.9.2 - 2013-01-04
+* Update dependencies to latest versions
+
+1.9.0 - 2012-07-16
+* Add Room#recent to get a list of recent messages
+* Add Room#search to search a room's transcripts
+
+1.4.3 - 2010-12-07
+* explicitly require 'uri'
+* added Room#tweet(url)
+
+1.4.2 - 2010-11-13
+* Use Faraday instead of HTTParty [eric]
+* Fix file uploads [eric]
+
+1.4.1 - 2010-10-09
+* Make SSL the default since it is available for all Campfire accounts.
+* Added MIT License
+
+1.4 - 2010-05-11
+* Remove methods no longer supported by API
+  Campfire#available_transcripts, Room#ping, Room#destroy, Room#toggle_guest_access
+* Added Room#play
+* ActiveSupport 3.0 support
+* Fix streaming API support
+* Allow SSL for listening
+* Add support for HTTP proxies [c13bcc0b]
+
+1.3.1 - 2009-12-17
+* Declare HTTParty dependency
+* Fix Room#paste
+
+1.3.0 - 2009-12-15
+* Rewrite to use Official Campfire API
+
+1.2.2 - 2009-09-12
+* Work around CSRF protection bug
+* Fixes for changes to Campfire markup
+* Include timestamps in the transcript
+
 1.2.1 - 2009-08-27
 * Fixes for listening after campfire updates [Jordan Byron]
 

data/Gemfile

@@ -0,0 +1,7 @@
+source 'http://rubygems.org'
+
+platforms :jruby do
+  gem 'jruby-openssl', '~> 0.7'
+end
+
+gemspec

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2006-2014 Brandon Keepers, Collective Idea
+
+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,47 @@
+# Tinder - get the Campfire started
+
+[![Gem Version](https://badge.fury.io/rb/tinder.png)](http://badge.fury.io/rb/tinder)
+[![Build Status](https://travis-ci.org/collectiveidea/tinder.png?branch=master)](https://travis-ci.org/collectiveidea/tinder)
+[![Code Climate](https://codeclimate.com/github/collectiveidea/tinder.png)](https://codeclimate.com/github/collectiveidea/tinder)
+[![Dependency Status](https://gemnasium.com/collectiveidea/tinder.png)](https://gemnasium.com/collectiveidea/tinder)
+
+Tinder is a library for interfacing with Campfire, the chat application from 37Signals, allowing you to programmatically manage and speak/listen in chat rooms.  As of December 2009, thanks to initial work from Joshua Peek at 37signals, it now makes use of the official Campfire API (described at: http://developer.37signals.com/campfire/).
+
+## Usage
+
+    campfire = Tinder::Campfire.new 'mysubdomain', :token => '546884b3d8fee4d80665g561caf7h9f3ea7b999e'
+    # or you can still use username/password and Tinder will look up your token
+    # campfire = Tinder::Campfire.new 'mysubdomain', :username => 'user', :password => 'pass'
+    # or if you have an OAuth token then you can use that to connect
+    # campfire = Tinder::Campfire.new 'mysubdomain', :oauth_token => '546884b3d8fee4d80665g561caf7h9f3ea7b999e'
+
+    room = campfire.rooms.first
+    room.rename 'New Room Names'
+    room.speak 'Hello world!'
+    room.paste "my pasted\ncode"
+
+    room = campfire.find_room_by_guest_hash 'abc123', 'John Doe'
+    room.speak 'Hello world!'
+
+See the RDoc for more details.
+
+## Installation
+
+    gem install tinder
+
+## Contributions
+
+Tinder is open source and contributions from the community are encouraged! No contribution is too small. Please consider:
+
+* adding an awesome feature
+* fixing a terrible bug
+* updating documentation
+* fixing a not-so-bad bug
+* fixing typos
+
+For the best chance of having your changes merged, please:
+
+1. Ask us! We'd love to hear what you're up to.
+2. Fork the project.
+3. Commit your changes and tests (if applicable (they're applicable)).
+4. Submit a pull request with a thorough explanation and at least one animated GIF.

data/Rakefile

@@ -1,65 +1,9 @@
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gem|
-    gem.name = "tinder"
-    gem.summary = "An (unofficial) Campfire API"
-    gem.description = "An API for interfacing with Campfire, the 37Signals chat application."
-    gem.authors = ['Brandon Keepers']
-    gem.email = 'brandon@opensoul.org'
-    gem.homepage = 'http://github.com/collectiveidea/tinder'
-    gem.rubyforge_project = "tinder"
-    gem.add_dependency "activesupport"
-    gem.add_dependency "httparty"
-    gem.add_dependency "mime-types"
-    gem.add_development_dependency "rspec"
-  end
-  Jeweler::GemcutterTasks.new
-rescue LoadError
-  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
-end
+require 'bundler'
+Bundler::GemHelper.install_tasks
 
-require 'rake/testtask'
-Rake::TestTask.new(:test) do |test|
-  test.libs << 'lib' << 'test'
-  test.pattern = 'test/**/*_test.rb'
-  test.verbose = true
-end
+require 'rspec/core/rake_task'
+desc 'Run the specs'
+RSpec::Core::RakeTask.new
 
-begin
-  require 'rcov/rcovtask'
-  Rcov::RcovTask.new do |test|
-    test.libs << 'test'
-    test.pattern = 'test/**/*_test.rb'
-    test.verbose = true
-  end
-rescue LoadError
-  task :rcov do
-    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
-  end
-end
-
-task :test => :check_dependencies
-
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
-  if File.exist?('VERSION')
-    version = File.read('VERSION')
-  else
-    version = ""
-  end
-
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "tinder #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
-
-require 'spec/rake/spectask'
-desc "Run the specs under spec"
-Spec::Rake::SpecTask.new do |t|
-  t.spec_opts = ['--options', "spec/spec.opts"]
-  t.spec_files = FileList['spec/**/*_spec.rb']
-end
-
-desc "Run tests"
-task :default => [:spec, :test]
+task :default => :spec
+task :test => :spec

data/init.rb

@@ -1 +1 @@
-require 'tinder'
+require 'tinder'

data/lib/faraday/response/raise_on_authentication_failure.rb

@@ -0,0 +1,10 @@
+# encoding: UTF-8
+require 'faraday'
+
+module Faraday
+  class Response::RaiseOnAuthenticationFailure < Response::Middleware
+    def on_complete(response)
+      raise Tinder::AuthenticationFailed if [401, 404].include?(response[:status])
+    end
+  end
+end

data/lib/faraday/response/remove_whitespace.rb

@@ -0,0 +1,10 @@
+# encoding: UTF-8
+require 'faraday'
+
+module Faraday
+  class Response::RemoveWhitespace < Response::Middleware
+    def parse(body)
+      body =~ /^\s+$/ ? "" : body
+    end
+  end
+end

data/lib/tinder/campfire.rb

@@ -1,9 +1,9 @@
+# encoding: UTF-8
 module Tinder
 
   # == Usage
   #
-  #   campfire = Tinder::Campfire.new 'mysubdomain'
-  #   campfire.login 'myemail@example.com', 'mypassword'
+  #   campfire = Tinder::Campfire.new 'mysubdomain', :token => 'xyz'
   #
   #   room = campfire.create_room 'New Room', 'My new campfire room to test tinder'
   #   room.speak 'Hello world!'
@@ -12,58 +12,44 @@ module Tinder
   #   room = campfire.find_room_by_guest_hash 'abc123', 'John Doe'
   #   room.speak 'Hello world!'
   class Campfire
-    HOST = "campfirenow.com"
-
-    attr_reader :connection, :subdomain, :uri
+    attr_reader :connection
 
     # Create a new connection to the campfire account with the given +subdomain+.
     #
     # == Options:
     # * +:ssl+: use SSL for the connection, which is required if you have a Campfire SSL account.
-    #           Defaults to false
+    #           Defaults to true
+    # * +:ssl_options+: SSL options passed to the underlaying Faraday connection. Allows to specify if the SSL certificate should be verified (:verify => true|false) and to specify the path to the ssl certs directory (:ca_path => "path/certs")
+    #           Defaults to {:verify => true}
     # * +:proxy+: a proxy URI. (e.g. :proxy => 'http://user:pass@example.com:8000')
     #
     #   c = Tinder::Campfire.new("mysubdomain", :ssl => true)
     def initialize(subdomain, options = {})
-      options = { :ssl => false }.merge(options)
-      @connection = Connection.new
-      @cookie = nil
-      @subdomain = subdomain
-      @uri = URI.parse("#{options[:ssl] ? 'https' : 'http' }://#{subdomain}.#{HOST}")
-      connection.base_uri @uri.to_s
-      if options[:proxy]
-        uri = URI.parse(options[:proxy])
-        @http = Net::HTTP::Proxy(uri.host, uri.port, uri.user, uri.password)
-      else
-        @http = Net::HTTP
-      end
-      @logged_in = false
-    end
-
-    # Log in to campfire using your +email+ and +password+
-    def login(username, password)
-      connection.basic_auth(username, password)
-      @logged_in = true
-    end
-
-    # Returns true when successfully logged in
-    def logged_in?
-      @logged_in == true
-    end
-
-    def logout
-      connection.default_options.delete(:basic_auth)
-      @logged_in = false
+      @connection = Connection.new(subdomain, options)
     end
 
     # Get an array of all the available rooms
     # TODO: detect rooms that are full (no link)
     def rooms
       connection.get('/rooms.json')['rooms'].map do |room|
-        Room.new(self, room)
+        Room.new(connection, room)
       end
     end
 
+    # Get an array of all rooms user is present in
+    def presence
+      connection.get('/presence.json')['rooms'].map do |room|
+        Room.new(connection, room)
+      end
+    end
+
+    # Find a campfire room by id
+    # NOTE: id should be of type Integer
+    def find_room_by_id(id)
+      id = id.to_i
+      rooms.detect { |room| room.id == id }
+    end
+
     # Find a campfire room by name
     def find_room_by_name(name)
       rooms.detect { |room| room.name == name }
@@ -76,7 +62,7 @@ module Tinder
 
     # Creates and returns a new Room with the given +name+ and optionally a +topic+
     def create_room(name, topic = nil)
-      connection.post('/rooms.json', :body => { :room => { :name => name, :topic => topic } }.to_json)
+      connection.post('/rooms.json', { :room => { :name => name, :topic => topic } })
       find_room_by_name(name)
     end
 
@@ -85,22 +71,13 @@ module Tinder
     end
 
     # List the users that are currently chatting in any room
-    def users(*room_names)
-      rooms.map(&:users).flatten.compact.uniq.sort
-    end
-
-    # Get the dates of the available transcripts by room
-    #
-    #   campfire.available_transcripts
-    #   #=> {"15840" => [#<Date: 4908311/2,0,2299161>, #<Date: 4908285/2,0,2299161>]}
-    #
-    def available_transcripts(room = nil)
-      raise NotImplementedError
+    def users
+      rooms.map(&:users).flatten.compact.uniq.sort_by {|u| u[:name]}
     end
 
-    # Is the connection to campfire using ssl?
-    def ssl?
-      uri.scheme == 'https'
+    # get the user info of the current user
+    def me
+      connection.get("/users/me.json")["user"]
     end
   end
 end

data/lib/tinder/connection.rb

@@ -1,21 +1,120 @@
-require 'httparty'
+# encoding: UTF-8
+require 'faraday'
+require 'faraday/request/multipart'
+require 'faraday/response/raise_on_authentication_failure'
+require 'faraday/response/remove_whitespace'
+require 'faraday_middleware'
+require 'json'
+require 'uri'
+
+class Faraday::RequestOptions
+  attr_accessor :preserve_raw
+end
 
 module Tinder
   class Connection
-    def initialize
-      class << self
-        include HTTParty
+    HOST = 'campfirenow.com'
+
+    attr_reader :subdomain, :uri, :options
+
+    def self.connection
+      @connection ||= Faraday.new do |builder|
+        builder.use     FaradayMiddleware::EncodeJson
+        builder.use     FaradayMiddleware::Mashify
+        builder.use     FaradayMiddleware::ParseJson
+        builder.use     Faraday::Response::RemoveWhitespace
+        builder.use     Faraday::Response::RaiseOnAuthenticationFailure
+        builder.adapter Faraday.default_adapter
+      end
+    end
+
+    def self.raw_connection
+      @raw_connection ||= Faraday.new do |builder|
+        builder.use     Faraday::Request::Multipart
+        builder.use     FaradayMiddleware::Mashify
+        builder.use     FaradayMiddleware::ParseJson
+        builder.use     Faraday::Response::RemoveWhitespace
+        builder.use     Faraday::Response::RaiseOnAuthenticationFailure
+        builder.adapter Faraday.default_adapter
+      end
+    end
+
+    def initialize(subdomain, options = {})
+      @subdomain = subdomain
+      @options = {:ssl => true, :ssl_options => {:verify => true}, :proxy => ENV['HTTP_PROXY']}
+      @options[:ssl_options][:verify] = options.delete(:ssl_verify) unless options[:ssl_verify].nil?
+      @options.merge!(options)
+      @uri = URI.parse("#{@options[:ssl] ? 'https' : 'http' }://#{subdomain}.#{HOST}")
+      @token = options[:token]
+      @oauth_token = options[:oauth_token]
+
+      if @oauth_token
+        connection.headers["Authorization"] = "Bearer #{@oauth_token}"
+        raw_connection.headers["Authorization"] = "Bearer #{@oauth_token}"
+      else
+        connection.basic_auth token, 'X'
+        raw_connection.basic_auth token, 'X'
+      end
+    end
+
+    def basic_auth_settings
+      {:username => token, :password => 'X'}
+    end
 
-        headers 'Content-Type' => 'application/json'
+    def connection
+      @connection ||= begin
+        conn = self.class.connection.dup
+        set_connection_options(conn)
+        conn
       end
     end
 
-    def metaclass
-      class << self; self; end
+    def raw_connection
+      @raw_connection ||= begin
+        conn = self.class.raw_connection.dup
+        set_connection_options(conn)
+        conn
+      end
+    end
+
+    def token
+      @token ||= begin
+        connection.basic_auth(options[:username], options[:password])
+        get('/users/me.json')['user']['api_auth_token']
+      end
+    end
+
+    def get(url, *args)
+      response = connection.get(url, *args)
+      response.body
+    end
+
+    def post(url, body = nil, *args)
+      response = connection.post(url, body, *args)
+      response.body
     end
 
-    def method_missing(*args, &block)
-      metaclass.send(*args, &block)
+    def raw_post(url, body = nil, *args)
+      response = raw_connection.post(url, body, *args)
+    end
+
+    def put(url, body = nil, *args)
+      response = connection.put(url, body, *args)
+      response.body
+    end
+
+    # Is the connection to campfire using ssl?
+    def ssl?
+      uri.scheme == 'https'
+    end
+
+  private
+    def set_connection_options(conn)
+      conn.url_prefix = @uri.to_s
+      conn.proxy options[:proxy]
+      if options[:ssl_options]
+        conn.ssl.merge!(options[:ssl_options])
+      end
     end
   end
 end