hipchat 1.5.1 → 1.5.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 46a4547a9f0d2cd12a211d78560fe3dfe7305b7b
+  data.tar.gz: 9c32aee4cd61577dff4f2d7ada82de5fc7151b95
+SHA512:
+  metadata.gz: a600e14c058610d0884bdc56a35838a5146a4603451b9f98eff32086af5452fb72193ed7d338ae56cbe3540d4817803223c7ae5db9988c5c801eaee74be5b84b
+  data.tar.gz: d4360c4bbf9958d8385c1e24d5fff0b22c13a36043b3943c05710a172a09b38c95b7a74e1da777ad5ef055b0f0c1cf0269f90149f210da8c4650a102ecb6fc68

data/README.textile

@@ -154,6 +154,7 @@ bc.. # Required
 set :hipchat_token, "<your token>"
 set :hipchat_room_name, "Your room" # If you pass an array such as ["room_a", "room_b"] you can send announcements to multiple rooms.
 # Optional
+set :hipchat_enabled, true # set to false to prevent any messages from being sent
 set :hipchat_announce, false # notify users
 set :hipchat_color, 'yellow' #normal message color
 set :hipchat_success_color, 'green' #finished deployment message color
@@ -201,6 +202,7 @@ room: ["Room name(s) or id(s)"] # this is an array
 user: "Your name" # Default to `whoami`
 notify: true # Defaults to false
 api_version: "v2" # optional, defaults to v1
+color: "yellow"
 
 h2. Engine Yard
 
@@ -209,12 +211,12 @@ Use a "deploy hook":http://bit.ly/qnbIkP to send messages from Engine Yard's Clo
 RAILS_ROOT/deploy/after_restart.rb:
 
 bc.. on_app_master do
-  message  = "Deploying revision #{revision[0...6]} to #{node[:environment][:name]}"
-  message += " (with migrations)" if migrate?
+  message  = "Deploying revision #{config.active_revision} to #{config.environment_name}"
+  message += " (with migrations)" if config.migrate?
   message += "."
 
   # Send a message via rake task assuming a hipchat.yml in your config like above
-  run "cd #{release_path} && bundle exec rake hipchat:send MESSAGE='#{message}'"
+  run "cd #{config.release_path} && bundle exec rake hipchat:send MESSAGE='#{message}'"
 end
 
 h2. Chef Handler

data/lib/hipchat/capistrano/tasks/hipchat.rake

@@ -25,7 +25,7 @@ namespace :hipchat do
   end
 
   def send_message(message, options)
-    return unless options[:notify]
+    return unless enabled?
 
     hipchat_token = fetch(:hipchat_token)
     hipchat_room_name = fetch(:hipchat_room_name)
@@ -51,6 +51,10 @@ namespace :hipchat do
     }
   end
 
+  def enabled?
+    fetch(:hipchat_enabled, true)
+  end
+
   def environment_string
     if fetch(:stage)
       "#{fetch(:stage)} (#{environment_name})"

data/lib/hipchat/capistrano2.rb

@@ -58,6 +58,8 @@ Capistrano::Configuration.instance(:must_exist).load do
     end
 
     def send(message, options)
+      return unless enabled?
+
       hipchat_options = fetch(:hipchat_options, {})
       set :hipchat_client, HipChat::Client.new(hipchat_token, hipchat_options) if fetch(:hipchat_client, nil).nil?
 
@@ -79,6 +81,10 @@ Capistrano::Configuration.instance(:must_exist).load do
       }
     end
 
+    def enabled?
+      fetch(:hipchat_enabled, true)
+    end
+
     def deployment_name
       if fetch(:branch, nil)
         name = "#{application}/#{branch}"

data/lib/hipchat/room.rb

@@ -230,11 +230,12 @@ module HipChat
     #                (default "JSON")
     def history(options = {})
 
-      options = { 
-        :date => 'recent', 
-        :timezone => 'UTC', 
-        :format => 'JSON', 
-        :'max-results' => 100 
+      options = {
+        :date => 'recent',
+        :timezone => 'UTC',
+        :format => 'JSON',
+        :'max-results' => 100,
+        :'start-index' => 0
       }.merge options
 
       response = self.class.get(@api.history_config[:url],
@@ -244,6 +245,7 @@ module HipChat
           :timezone   => options[:timezone],
           :format     => options[:format],
           :'max-results' => options[:'max-results'],
+          :'start-index' => options[:'start-index'],
           :auth_token => @token
         },
         :headers => @api.headers

data/lib/hipchat/version.rb

@@ -1,3 +1,3 @@
 module HipChat
-  VERSION = '1.5.1'
+  VERSION = '1.5.2'
 end

data/spec/hipchat_api_v1_spec.rb

@@ -15,8 +15,8 @@ describe "HipChat (API V1)" do
     end
 
     it "is successful with custom options" do
-      mock_successful_history(:timezone => 'America/Los_Angeles', :date => '2010-11-19', :'max-results' => 10)
-      expect(room.history(:timezone => 'America/Los_Angeles', :date => '2010-11-19', :'max-results' => 10)).to be_truthy
+      mock_successful_history(:timezone => 'America/Los_Angeles', :date => '2010-11-19', :'max-results' => 10, :'start-index' => 10)
+      expect(room.history(:timezone => 'America/Los_Angeles', :date => '2010-11-19', :'max-results' => 10, :'start-index' => 10)).to be_truthy
     end
 
     it "is successful from fetched room" do

data/spec/hipchat_api_v2_spec.rb

@@ -16,8 +16,8 @@ describe "HipChat (API V2)" do
     end
 
     it "is successful with custom options" do
-      mock_successful_history(:timezone => 'America/Los_Angeles', :date => '2010-11-19', :'max-results' => 10)
-      expect(room.history(:timezone => 'America/Los_Angeles', :date => '2010-11-19', :'max-results' => 10)).to be_truthy
+      mock_successful_history(:timezone => 'America/Los_Angeles', :date => '2010-11-19', :'max-results' => 10, :'start-index' => 10)
+      expect(room.history(:timezone => 'America/Los_Angeles', :date => '2010-11-19', :'max-results' => 10, :'start-index' => 10)).to be_truthy
     end
 
     it "is successful from fetched room" do

data/spec/hipchat_spec.rb

@@ -35,4 +35,39 @@ describe HipChat do
       end
     end
   end
+
+  describe 'options' do
+
+    context "api_version" do
+
+      it "defaults to a v1 client" do
+        client = HipChat::Client.new("blah")
+        expect(client[:example].api_version).to eql('v1')
+      end
+
+      it "when given 'v1' it registers a v1 client" do
+        client = HipChat::Client.new("blah", :api_version => 'v1')
+        expect(client[:example].api_version).to eql('v1')
+      end
+
+      it "when given 'v2' it registers a v2 client" do
+        client = HipChat::Client.new("blah", :api_version => 'v2')
+        expect(client[:example].api_version).to eql('v2')
+      end
+    end
+
+    context "server_url" do
+
+      it "defaults to 'https://api.hipchat.com'" do
+        client = HipChat::Client.new("derr")
+        expect(client[:example].server_url).to eql('https://api.hipchat.com')
+      end
+
+      it "can be overridden to 'http://hipchat.example.com'" do
+        client = HipChat::Client.new("derr", :server_url => 'http://hipchat.example.com')
+        expect(client[:example].server_url).to eql('http://hipchat.example.com')
+      end
+    end
+  end
 end
+

data/spec/support/shared_contexts_for_hipchat.rb

@@ -41,13 +41,14 @@ shared_context "HipChatV1" do
   end
 
   def mock_successful_history(options={})
-    options = { :date => 'recent', :timezone => 'UTC', :format => 'JSON', :'max-results' => 100 }.merge(options)
+    options = { :date => 'recent', :timezone => 'UTC', :format => 'JSON', :'max-results' => 100, :'start-index' => 0 }.merge(options)
     canned_response = File.new(HISTORY_JSON_PATH)
     stub_request(:get, "https://api.hipchat.com/v1/rooms/history").with(:query => {:auth_token => "blah",
                                    :room_id       => "Hipchat",
                                    :date          => options[:date],
                                    :timezone      => options[:timezone],
                                    :'max-results' => options[:'max-results'],
+                                   :'start-index' => options[:'start-index'],
                                    :format        => options[:format]}).to_return(canned_response)
   end
 
@@ -112,13 +113,14 @@ shared_context "HipChatV2" do
   end
 
   def mock_successful_history(options={})
-    options = { :date => 'recent', :timezone => 'UTC', :format => 'JSON', :'max-results' => 100 }.merge(options)
+    options = { :date => 'recent', :timezone => 'UTC', :format => 'JSON', :'max-results' => 100, :'start-index' => 0 }.merge(options)
     canned_response = File.new(HISTORY_JSON_PATH)
     stub_request(:get, "https://api.hipchat.com/v2/room/Hipchat/history").with(:query => {:auth_token => "blah",
                                    :room_id    => "Hipchat",
                                    :date       => options[:date],
                                    :timezone   => options[:timezone],
                                    :'max-results' => options[:'max-results'],
+                                   :'start-index' => options[:'start-index'],
                                    :format     => options[:format]}).to_return(canned_response)
   end
 

metadata

@@ -1,158 +1,139 @@
 --- !ruby/object:Gem::Specification
 name: hipchat
 version: !ruby/object:Gem::Version
-  version: 1.5.1
-  prerelease: 
+  version: 1.5.2
 platform: ruby
 authors:
 - HipChat/Atlassian
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-08 00:00:00.000000000 Z
+date: 2015-07-20 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: mimemagic
   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: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
   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: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   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: webmock
   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: rdoc
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>'
+    - - ">"
       - !ruby/object:Gem::Version
         version: 2.4.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>'
+    - - ">"
       - !ruby/object:Gem::Version
         version: 2.4.2
 - !ruby/object:Gem::Dependency
   name: coveralls
   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'
 description: Ruby library to interact with HipChat
@@ -162,12 +143,12 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .coveralls.yml
-- .document
-- .gitignore
-- .ruby-gemset
-- .ruby-version
-- .travis.yml
+- ".coveralls.yml"
+- ".document"
+- ".gitignore"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
 - Gemfile
 - LICENSE
 - README.textile
@@ -197,27 +178,26 @@ files:
 homepage: https://github.com/hipchat/hipchat-rb
 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: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.29
+rubygems_version: 2.4.6
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Ruby library to interact with HipChat
 test_files:
 - spec/example/history.json