hipchat 0.9.0 → 0.10.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 24cf2734642567d8b9776d38a0692c10da6c7950
+  data.tar.gz: 35631b2283ed2d4b6667079543bb1ad1e7fc35ab
+SHA512:
+  metadata.gz: 68e9b8c4efd921c20a0a53d772dbc1dc3b836d426738d4c25b1f2502b34401abcae5971820ef6d131fdcc9ad79f865e919a31853791adfa5399e75c45f5274b2
+  data.tar.gz: 80d29347ebaf6a6d5d802eb66ea17df29f0bf9077d0a8ace7899e692f39693039500ac7be9bc6fc4ecaa5c150c0837a7371133992cfed69587724ff0ad87d278

data/.gitignore

@@ -0,0 +1,35 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+doc/
+lib/bundler/man
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+## PROJECT::SPECIFIC

data/Gemfile

@@ -1,14 +1,4 @@
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
-gem "httparty"
-
-group :test do
-  gem "rake"
-  gem "rspec"
-  gem "rr"
-end
-
-group :development do
-  gem "jeweler"
-  gem "builder"
-end
+# Specify your gem's dependencies in hipchat.gemspec
+gemspec

data/Gemfile.lock

@@ -1,40 +1,43 @@
+PATH
+  remote: .
+  specs:
+    hipchat (0.10.0)
+      httparty
+
 GEM
   remote: https://rubygems.org/
   specs:
-    builder (3.2.0)
-    diff-lcs (1.1.3)
-    git (1.2.5)
-    httparty (0.9.0)
+    addressable (2.3.4)
+    crack (0.4.0)
+      safe_yaml (~> 0.9.0)
+    diff-lcs (1.2.4)
+    httparty (0.11.0)
       multi_json (~> 1.0)
-      multi_xml
-    jeweler (1.8.4)
-      bundler (~> 1.0)
-      git (>= 1.2.5)
-      rake
-      rdoc
-    json (1.7.7)
-    multi_json (1.3.6)
-    multi_xml (0.5.1)
-    rake (0.9.2.2)
-    rdoc (3.12)
-      json (~> 1.4)
-    rr (1.0.4)
-    rspec (2.11.0)
-      rspec-core (~> 2.11.0)
-      rspec-expectations (~> 2.11.0)
-      rspec-mocks (~> 2.11.0)
-    rspec-core (2.11.1)
-    rspec-expectations (2.11.3)
-      diff-lcs (~> 1.1.3)
-    rspec-mocks (2.11.3)
+      multi_xml (>= 0.5.2)
+    multi_json (1.7.3)
+    multi_xml (0.5.3)
+    rake (10.0.4)
+    rr (1.0.5)
+    rspec (2.13.0)
+      rspec-core (~> 2.13.0)
+      rspec-expectations (~> 2.13.0)
+      rspec-mocks (~> 2.13.0)
+    rspec-core (2.13.1)
+    rspec-expectations (2.13.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.13.1)
+    safe_yaml (0.9.3)
+    webmock (1.11.0)
+      addressable (>= 2.2.7)
+      crack (>= 0.3.2)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  builder
-  httparty
-  jeweler
+  bundler (~> 1.3)
+  hipchat!
   rake
   rr
   rspec
+  webmock

data/README.textile

@@ -26,6 +26,11 @@ client['my room'].topic('Free Ice Cream in the kitchen')
 # Change the from field for a topic update (default "API")
 client['my room'].topic('Weekely sales: $10,000', :from => 'Sales Team')
 
+# Get history from a room 
+client['my room'].history()
+
+# Get history for a date in time with a particular timezone (default is latest 75 messages, timezone default is 'UTC')
+client['my room'].history(:date => '2010-11-19', :timezone => 'PST')
 
 
 h2. Capistrano

data/Rakefile

@@ -1,29 +1,10 @@
-require 'rubygems'
-require 'rake'
-
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gem|
-    gem.name = "hipchat"
-    gem.summary = %Q{Ruby library to interact with HipChat}
-    gem.description = %Q{Ruby library to interact with HipChat}
-    gem.email = "support@hipchat.com"
-    gem.homepage = "https://github.com/hipchat/hipchat-rb"
-    gem.authors = ["HipChat/Atlassian"]
-    gem.add_dependency "httparty"
-    gem.add_development_dependency "rspec", "~> 2.0"
-    gem.add_development_dependency "rr", "~> 1.0"
-  end
-  Jeweler::GemcutterTasks.new
-rescue LoadError
-  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
-end
+require "bundler/gem_tasks"
 
 task :default => :spec
 
 require 'rdoc/task'
 Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+  version = HipChat::VERSION
 
   rdoc.rdoc_dir = 'rdoc'
   rdoc.title = "hipchat #{version}"

data/hipchat.gemspec

@@ -1,70 +1,28 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
-# -*- encoding: utf-8 -*-
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'hipchat/version'
 
-Gem::Specification.new do |s|
-  s.name = "hipchat"
-  s.version = "0.9.0"
+Gem::Specification.new do |spec|
+  spec.name          = "hipchat"
+  spec.version       = HipChat::VERSION
+  spec.authors       = ["HipChat/Atlassian"]
+  spec.email         = ["support@hipchat.com"]
+  spec.description   = %q{Ruby library to interact with HipChat}
+  spec.summary       = %q{Ruby library to interact with HipChat}
+  spec.homepage      = "https://github.com/hipchat/hipchat-rb"
+  spec.license       = "MIT"
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["HipChat/Atlassian"]
-  s.date = "2013-05-18"
-  s.description = "Ruby library to interact with HipChat"
-  s.email = "support@hipchat.com"
-  s.extra_rdoc_files = [
-    "LICENSE",
-    "README.textile"
-  ]
-  s.files = [
-    ".document",
-    ".travis.yml",
-    "Gemfile",
-    "Gemfile.lock",
-    "LICENSE",
-    "README.textile",
-    "Rakefile",
-    "VERSION",
-    "hipchat.gemspec",
-    "lib/hipchat.rb",
-    "lib/hipchat/capistrano.rb",
-    "lib/hipchat/chef.rb",
-    "lib/hipchat/rails3_tasks.rb",
-    "lib/hipchat/railtie.rb",
-    "spec/hipchat_spec.rb",
-    "spec/spec.opts",
-    "spec/spec_helper.rb"
-  ]
-  s.homepage = "https://github.com/hipchat/hipchat-rb"
-  s.require_paths = ["lib"]
-  s.rubygems_version = "1.8.24"
-  s.summary = "Ruby library to interact with HipChat"
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
 
-  if s.respond_to? :specification_version then
-    s.specification_version = 3
+  spec.add_dependency "httparty"
 
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<httparty>, [">= 0"])
-      s.add_development_dependency(%q<jeweler>, [">= 0"])
-      s.add_development_dependency(%q<builder>, [">= 0"])
-      s.add_runtime_dependency(%q<httparty>, [">= 0"])
-      s.add_development_dependency(%q<rspec>, ["~> 2.0"])
-      s.add_development_dependency(%q<rr>, ["~> 1.0"])
-    else
-      s.add_dependency(%q<httparty>, [">= 0"])
-      s.add_dependency(%q<jeweler>, [">= 0"])
-      s.add_dependency(%q<builder>, [">= 0"])
-      s.add_dependency(%q<httparty>, [">= 0"])
-      s.add_dependency(%q<rspec>, ["~> 2.0"])
-      s.add_dependency(%q<rr>, ["~> 1.0"])
-    end
-  else
-    s.add_dependency(%q<httparty>, [">= 0"])
-    s.add_dependency(%q<jeweler>, [">= 0"])
-    s.add_dependency(%q<builder>, [">= 0"])
-    s.add_dependency(%q<httparty>, [">= 0"])
-    s.add_dependency(%q<rspec>, ["~> 2.0"])
-    s.add_dependency(%q<rr>, ["~> 1.0"])
-  end
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rr"
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "webmock"
 end
-

data/lib/hipchat.rb

@@ -2,6 +2,7 @@ require 'httparty'
 require 'ostruct'
 
 require 'hipchat/railtie' if defined?(Rails::Railtie)
+require "hipchat/version"
 
 module HipChat
   class UnknownRoom         < StandardError; end
@@ -129,5 +130,46 @@ module HipChat
         raise UnknownResponseCode, "Unexpected #{response.code} for room `#{room_id}'"
       end
     end
+
+    # Pull this room's history
+    #
+    # Usage
+    #
+    #   # Default
+    #
+    #
+    # Options
+    #
+    # +date+::     Whether to return a specific day (YYYY-MM-DD format) or recent
+    #                (default "recent")
+    # +timezone+:: Your timezone.  Supported timezones are at: https://www.hipchat.com/docs/api/timezones
+    #                (default "UTC")
+    # +format+::   Format to retrieve the history in.  Valid options are JSON and XML
+    #                (default "JSON")
+    def history(options = {})
+
+      options = { :date => 'recent', :timezone => 'UTC', :format => 'JSON' }.merge options
+
+      response = self.class.get('/history',
+        :query => {
+          :room_id    => room_id,
+          :date       => options[:date],
+          :timezone   => options[:timezone],
+          :format     => options[:format],
+          :auth_token => @token,
+        }
+      )
+
+      case response.code
+      when 200
+        response.body
+      when 404
+        raise UnknownRoom,  "Unknown room: `#{room_id}'"
+      when 401
+        raise Unauthorized, "Access denied to room `#{room_id}'"
+      else
+        raise UnknownResponseCode, "Unexpected #{response.code} for room `#{room_id}'"
+      end
+    end
   end
 end

data/lib/hipchat/version.rb

@@ -0,0 +1,3 @@
+module HipChat
+  VERSION = "0.10.0"
+end

data/spec/example/history.json

@@ -0,0 +1,36 @@
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+  "messages": [
+    {
+      "date": "2010-11-19T15:48:19-0800",
+      "from": {
+        "name": "Garret Heaton",
+        "user_id": 10
+      },
+      "message": "Good morning! This is a regular message."
+    },
+    {
+      "date": "2010-11-19T15:49:44-0800",
+      "from": {
+        "name": "Garret Heaton",
+        "user_id": 10
+      },
+      "file": {
+        "name": "Screenshot.png",
+        "size": 141909,
+        "url": "http:\/\/uploads.hipchat.com\/xxx\/Screenshot.png"
+      },
+      "message": "This is a file upload"
+    },
+    {
+      "date": "2010-11-19T16:13:40-0800",
+      "from": {
+        "name": "Deploy Bot",
+        "user_id": "api"
+      },
+      "message": "This message is sent via the API so the user_id is 'api'."
+    }
+  ]
+}

data/spec/hipchat_spec.rb

@@ -31,6 +31,54 @@ describe HipChat do
     }
   end
 
+  def mock_successful_history(options={})
+    options = { :date => 'recent', :timezone => 'UTC', :format => 'JSON' }.merge(options)
+    canned_response = File.new File.expand_path(File.dirname(__FILE__) + '/example/history.json')
+    stub_request(:get, "https://api.hipchat.com/v1/rooms/history").with(:query => {:auth_token => "blah",
+                                   :room_id    => "Hipchat",
+                                   :date       => options[:date],
+                                   :timezone   => options[:timezone],
+                                   :format     => options[:format]}).to_return(canned_response)
+  end
+
+  describe "#history" do
+    it "is successful without custom options" do
+      mock_successful_history()
+
+      room.history().should be_true
+    end
+
+    it "is successful with custom options" do
+      mock_successful_history(:timezone => 'America/Los_Angeles', :date => '2010-11-19')
+      room.history(:timezone => 'America/Los_Angeles', :date => '2010-11-19').should be_true
+    end
+
+    it "fails when the room doen't exist" do
+      mock(HipChat::Room).get(anything, anything) {
+        OpenStruct.new(:code => 404)
+      }
+
+      lambda { room.history }.should raise_error(HipChat::UnknownRoom)
+    end
+
+    it "fails when we're not allowed to do so" do
+      mock(HipChat::Room).get(anything, anything) {
+        OpenStruct.new(:code => 401)
+      }
+
+      lambda { room.history }.should raise_error(HipChat::Unauthorized)
+    end
+
+    it "fails if we get an unknown response code" do
+      mock(HipChat::Room).get(anything, anything) {
+        OpenStruct.new(:code => 403)
+      }
+
+      lambda { room.history }.
+        should raise_error(HipChat::UnknownResponseCode)
+    end
+  end
+
   describe "#topic" do
     it "is successful without custom options" do
       mock_successful_topic_change("Nice topic")

data/spec/spec_helper.rb

@@ -3,6 +3,7 @@ $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 require 'hipchat'
 require 'rspec'
 require 'rspec/autorun'
+require 'webmock/rspec'
 
 RSpec.configure do |config|
   config.mock_with :rr

metadata

@@ -1,162 +1,151 @@
 --- !ruby/object:Gem::Specification
 name: hipchat
 version: !ruby/object:Gem::Version
-  version: 0.9.0
-  prerelease: 
+  version: 0.10.0
 platform: ruby
 authors:
 - HipChat/Atlassian
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-18 00:00:00.000000000 Z
+date: 2013-06-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: jeweler
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: builder
+  name: rr
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: httparty
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
+        version: '1.3'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.3'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rr
+  name: webmock
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0'
 description: Ruby library to interact with HipChat
-email: support@hipchat.com
+email:
+- support@hipchat.com
 executables: []
 extensions: []
-extra_rdoc_files:
-- LICENSE
-- README.textile
+extra_rdoc_files: []
 files:
 - .document
+- .gitignore
 - .travis.yml
 - Gemfile
 - Gemfile.lock
 - LICENSE
 - README.textile
 - Rakefile
-- VERSION
 - hipchat.gemspec
 - lib/hipchat.rb
 - lib/hipchat/capistrano.rb
 - lib/hipchat/chef.rb
 - lib/hipchat/rails3_tasks.rb
 - lib/hipchat/railtie.rb
+- lib/hipchat/version.rb
+- spec/example/history.json
 - spec/hipchat_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
 homepage: https://github.com/hipchat/hipchat-rb
-licenses: []
+licenses:
+- MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -3630291999816657472
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Ruby library to interact with HipChat
-test_files: []
+test_files:
+- spec/example/history.json
+- spec/hipchat_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb

data/VERSION

@@ -1 +0,0 @@
-0.9.0