jibbajabba 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d14d3980345b9f15d53d6ce3d2132625e237c7e5
+  data.tar.gz: 93e77c79a9db38611c8c3f786e2451308758744b
+SHA512:
+  metadata.gz: aeec94bffc6f202958940a86698ed9728ed49791f92c802d958e247f286e9c1419384bc5d378cbb0c27f775eccd514b019c2546cb5734a286ca96bb42dcd8ece
+  data.tar.gz: 3ea3402db5ed3968bedc42281f5a67cd777ce2e03e850573e135bfb28a1fd6ef8ed6ba05caa346437f6761a77d22eca7e96ab4c6efaf6fecaf4f277323d66110

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in jibbajabba.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Nathaniel Wroblewski
+
+MIT License
+
+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.md

@@ -0,0 +1,77 @@
+# JibbaJabba
+
+JibbaJabba is a fluent Ruby wrapper for the HipChat API using familiar ActiveRecord syntax.  For example, you may chain familiar methods like `#all`, `#limit`, or `#offset` as in:
+```rb
+HipChat::Room.all.offset(25).limit(100)
+```
+to query the HipChat API at `https://api.hipchat.com/v2/room?start-index=25&max-results=100`.
+
+![Mr. T wants you to quit yo jibbajabba](https://raw.github.com/NathanielWroblewski/jibbajabba/master/mrt.jpg)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'jibbajabba'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install jibbajabba
+
+## Usage
+
+First, set your API key, which you can obtain [here](https://www.hipchat.com/account/api).
+
+```rb
+# set it directly using the attr_accessor
+HipChat.api_key = 'MY HIPCHAT API KEY GOES HERE'
+
+# set it by passing a block
+HipChat.configure do |config|
+  config.api_key = 'MY HIPCHAT API KEY GOES HERE'
+end
+```
+
+Be safe with API keys.  Use environment variables or the [Figaro](https://github.com/laserlemon/figaro) gem or something.
+
+There are two HipChat API "models" that you can query: `HipChat::Room` and `HipChat::User`.  All queries can be kicked by calling `#to_hash` or any `Hash` or `Enumerable` method on the `HipChat::Room` response object.
+
+HipChat::Room
+---
+Examples:
+```rb
+# Note that the kicker ('#to_hash', etc.) must be called to hashify the return object or else 
+# you'll get a HipChat::Room object which is probably not what you want
+HipChat::Room.all
+# => Returns a HipChat::Room object of all rooms for the user
+
+HipChat::Room.all.to_hash
+# => Returns a Ruby Hash of all rooms for the user
+
+HipChat::Room.all.each{ |key, value| p "#{key}: #{value}"}
+# => Returns a Ruby Hash and prints all key-value pairs
+
+# Construct API queries using familiar ActiveRecord syntax
+HipChat::Room.all.limit(100).offset(25).to_hash
+# => Returns the result (as a Ruby Hash) from querying the API at
+# https://api.hipchat.com/v2/room?start-index=25&max-results=100
+```
+
+Methods:
+```rb
+HipChat::Room.all # => all rooms for the user, default limit of 100, default start index of 0
+HipChat::Room.all.limit(10) # => change the default limit
+HipChat::Room.all.offset(25) # => change the start index
+```
+
+## Contributing
+
+1. Fork it ( http://github.com/NathanielWroblewski/jibbajabba/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/jibbajabba.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'jibbajabba/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'jibbajabba'
+  spec.version       = JibbaJabba::VERSION
+  spec.authors       = ['Nathaniel Wroblewski']
+  spec.email         = ['NathanielWroblewski@gmail.com']
+  spec.summary       = %q{Fluent Ruby API wrapper for the HipChat API}
+  spec.description   = %q{Fluent Ruby API wrapper for the HipChat API}
+  spec.homepage      = 'https://github.com/NathanielWroblewski/jibbajabba'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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']
+
+  spec.add_development_dependency 'bundler', '~> 1.5'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rspec-mocks'
+end

data/lib/jibbajabba.rb

@@ -0,0 +1,5 @@
+require 'jibbajabba/version'
+require 'jibbajabba/hip_chat'
+require 'jibbajabba/room'
+require 'open-uri'
+require 'json'

data/lib/jibbajabba/hip_chat.rb

@@ -0,0 +1,16 @@
+module HipChat
+  URL = 'https://api.hipchat.com/v2/'
+
+  class << self
+
+    attr_accessor :api_key
+
+    def configure
+      yield self if block_given?
+    end
+
+    def credentials
+      {'Authorization' => 'Bearer ' + api_key}
+    end
+  end
+end

data/lib/jibbajabba/room.rb

@@ -0,0 +1,50 @@
+module HipChat
+  class Room
+    class << self
+
+      undef_method :to_s, :inspect
+
+      attr_writer :query
+
+      def query
+        @query ||= url
+      end
+
+      def all
+        @query = url
+        self
+      end
+      alias_method :list, :all
+
+      def offset(number)
+        @query += "start-index=#{number.to_i}&"
+        self
+      end
+      alias_method :start_index, :offset
+
+      def limit(number)
+        @query += "max-results=#{number.to_i}&"
+        self
+      end
+      alias_method :max_results, :limit
+
+      def url
+        URL + 'room?'
+      end
+
+      def to_hash
+        raise 'No API key assigned.' unless HipChat.api_key
+        response = open(query, HipChat.credentials){|f| f.read }
+        JSON.parse(response)
+      end
+
+      def class
+        'HipChat::Room'
+      end
+
+      def method_missing(method, *args, &block)
+        to_hash.send(method, *args, &block)
+      end
+    end
+  end
+end

data/lib/jibbajabba/version.rb

@@ -0,0 +1,3 @@
+module JibbaJabba
+  VERSION = "0.0.1"
+end

data/spec/lib/jibbajabba/hip_chat_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe HipChat, '::URL' do
+  it 'returns the api url' do
+    expect(HipChat::URL).to eq 'https://api.hipchat.com/v2/'
+  end
+end
+
+describe HipChat, '.configure' do
+  let(:api_key) { SecureRandom.hex }
+
+  it 'sets the api key when passed a block assigning the key' do
+    HipChat.configure{|config| config.api_key = api_key }
+
+    expect(HipChat.api_key).to eq api_key
+  end
+end
+
+describe HipChat, '.credentials' do
+  let(:api_key) { SecureRandom.hex }
+
+  it 'returns the API authorization headers' do
+    HipChat.api_key = api_key
+
+    expect(HipChat.credentials).to eq({'Authorization' => "Bearer #{api_key}"})
+  end
+end

data/spec/lib/jibbajabba/room_spec.rb

@@ -0,0 +1,96 @@
+require 'spec_helper'
+
+describe HipChat::Room do
+  before :each do
+    HipChat.api_key = nil
+    HipChat::Room.stub(:to_hash)
+    HipChat::Room.all
+  end
+
+  describe '.url' do
+    it 'returns the API url appended with "room"' do
+      api_url = HipChat::URL + 'room?'
+
+      expect(HipChat::Room.url).to eq api_url
+    end
+  end
+
+  describe '.query' do
+    it 'defaults to the url' do
+      expect(HipChat::Room.query).to eq HipChat::Room.url
+    end
+  end
+
+  describe '.all' do
+    it 'queries the API for the list of rooms' do
+      HipChat::Room.all
+
+      expect(HipChat::Room.query).to eq HipChat::Room.url
+    end
+  end
+
+  describe '.offset' do
+    it 'sets the start index for the API query' do
+      HipChat::Room.offset(5)
+
+      expect(HipChat::Room.query).to eq(HipChat::Room.url + 'start-index=5&')
+    end
+  end
+
+  describe '.limit' do
+    it 'sets the maximum number of results for the API query' do
+      HipChat::Room.limit(5)
+
+      expect(HipChat::Room.query).to eq(HipChat::Room.url + 'max-results=5&')
+    end
+  end
+
+  describe '.class' do
+    it 'returns HipChat::Room' do
+      expect(HipChat::Room.class).to eq 'HipChat::Room'
+    end
+  end
+
+  describe '.to_hash' do
+    let(:api_key)      { SecureRandom.hex }
+    let(:api_response) { JSON.dump({ hello: 'world' }) }
+
+    before :each do
+      HipChat::Room.unstub(:to_hash)
+      HipChat::Room.stub(:open).and_return(api_response)
+      HipChat.api_key = api_key
+    end
+
+    it 'kicks the API query' do
+      response = HipChat::Room.all.to_hash
+
+      expect(HipChat::Room).to have_received(:open).with(
+        'https://api.hipchat.com/v2/room?',
+        { 'Authorization' => "Bearer #{api_key}"}
+      )
+      expect(response).to eq({'hello' => 'world'})
+    end
+
+    it 'kicks chained API queries' do
+      HipChat::Room.all.limit(5).offset(7).to_hash
+
+      expect(HipChat::Room).to have_received(:open).with(
+        'https://api.hipchat.com/v2/room?max-results=5&start-index=7&',
+        { 'Authorization' => "Bearer #{api_key}"}
+      )
+    end
+
+    it 'errors unless an API key is set' do
+      HipChat.api_key = nil
+      blah = HipChat::Room rescue nil
+
+      expect(
+        begin
+          HipChat::Room.to_hash
+        rescue Exception => e
+          e.message
+        end
+      ).to eq 'No API key assigned.'
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'jibbajabba'
+require 'securerandom'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: jibbajabba
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Nathaniel Wroblewski
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-mocks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Fluent Ruby API wrapper for the HipChat API
+email:
+- NathanielWroblewski@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- jibbajabba.gemspec
+- lib/jibbajabba.rb
+- lib/jibbajabba/hip_chat.rb
+- lib/jibbajabba/room.rb
+- lib/jibbajabba/version.rb
+- mrt.jpg
+- spec/lib/jibbajabba/hip_chat_spec.rb
+- spec/lib/jibbajabba/room_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/NathanielWroblewski/jibbajabba
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Fluent Ruby API wrapper for the HipChat API
+test_files:
+- spec/lib/jibbajabba/hip_chat_spec.rb
+- spec/lib/jibbajabba/room_spec.rb
+- spec/spec_helper.rb