hip_chat 0.1.2

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    OTM5YjU0MmYzOTgxZmEyNWY2NDE1MTg5MGIwYWJhNjdiMjI1N2FmMw==
+  data.tar.gz: !binary |-
+    YjVjNzFlZDY2NzA1ZWNlZjI4YmQ2MmQzYzdlYzEwNTgyOWJiYTE5ZQ==
+SHA512:
+  metadata.gz: !binary |-
+    MGEwZjBmZDEzODQ0NTJmODgxOWQ5YmExNzJiYmIyZTU2NzliMjJkOGMzMjVm
+    ZDE1MjI5NTVmNzE1OTk2YmQ3ZWJiNDk2ZGIyYTBkOTYzZDZkMzcwNDAzYmNi
+    OTFlY2I2MjhlMmFmY2IzMGRmNWUwNDU3ZWQ2ZWQ4ZDNjNmNlNzY=
+  data.tar.gz: !binary |-
+    YTcwMDcwZDk4ZmVkNzk5NDAwODUwNDIxZTEyODlmYWRhYjM5ZTQxMThkZDlk
+    ZjY5M2Q1ODFlZDdmYjZhYWEwNDgzODExZmRkMmMzNWFkMjgyMDkwMjI5YTRj
+    OTg5M2Y2ZmU5MzQxMjAzN2FjYmQ2MzM2NmMwNzA0OTI1Y2QwMjM=

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.swp

data/.ruby-gemset

@@ -0,0 +1 @@
+hip_chat

data/.ruby-version

@@ -0,0 +1 @@
+1.9.3

data/.travis.yml

@@ -0,0 +1,16 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.2.0
+env: RAKE_ENV=test RAILS_ENV=test
+before_install:
+  - 'gem install bundler'
+script:
+  - 'bundle exec rspec'
+notifications:
+  email:
+    recipients:
+      - humzashah+travis@gmail.com
+    on_success: never
+    on_failure: always

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 TODO: Write your name
+
+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,56 @@
+# HipChat
+
+Easily control [HipChat](https://www.hipchat.com) with Ruby.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'hip_chat'
+```
+
+and run `bundle install`
+
+## Features
+
+Currently, this gem lets you view, edit, create, and destroy users on HipChat.
+
+## Features for the Near Future
+
+Providing more methods to interact with HipChat. The long-term plan is to cover all of the interactions possible with [HipChat API v2](https://www.hipchat.com/docs/apiv2).
+
+## Usage
+
+```ruby
+@api = HipChat::Api.new(authorization_token)
+
+# get list of users:
+@users = @api.users
+
+# find users by id, email, or mention_name:
+finder = {
+  mention_name: "SyedHumzaShah"
+} # or {id: id} or {email: email}
+user = @users.find(mention_name: "SyedHumzaShah")
+# ^ alternate: HipChat::User.find(token, finder)
+
+# create new users:
+attributes = {
+  email: "some_email@domain.com",
+  name: "Syed Humza Shah",
+  password: some_password
+}
+user = @users.create!(attributes) # or @users.create(attributes)
+# ^ alternate: HipChat::User.create(token, attributes)
+
+# update users:
+user.name = "Syed Humza"
+user.save! # or user.save
+
+# delete a user:
+user.destroy! # or user.destroy
+
+# refresh users' list
+@api.refresh_users
+```

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "hip_chat"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/hip_chat.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'hip_chat/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "hip_chat"
+  spec.version       = HipChat::VERSION
+  spec.authors       = ["Syed Humza Shah"]
+  spec.email         = ["humzashah+github@gmail.com"]
+
+  spec.summary       = "Use Ruby to control HipChat."
+  spec.description   = "Easily communicate with HipChat using via their API's v2."
+  spec.homepage      = "https://github.com/humzashah/hip_chat"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = '>= 1.9.3'
+
+  spec.add_development_dependency "bundler", ">= 1.8"
+  spec.add_development_dependency "rake", ">= 10.0"
+  spec.add_development_dependency "httparty"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "webmock"
+end

data/lib/hip_chat.rb

@@ -0,0 +1,7 @@
+require "hip_chat/version"
+
+module HipChat
+end
+
+parent_folder = Pathname.new(__FILE__).parent.to_s
+Dir[File.join(parent_folder, "hip_chat", "*.rb")].each { |path| require(path) }

data/lib/hip_chat/api.rb

@@ -0,0 +1,29 @@
+require_relative "common_methods"
+require_relative "user"
+require_relative "relation"
+
+module HipChat
+  class Api
+    include CommonMethods
+
+    attr_reader :token, :users
+
+    def initialize(token)
+      @token = token
+      validate_token
+    end
+
+    def refresh_users
+      response = get_request(User::URL, auth_hash)
+      users_list = validate_response(response)["items"]
+
+      @users = Relation.new(token, users_list, User)
+    end
+
+    private
+
+    def validate_token
+      refresh_users
+    end
+  end
+end

data/lib/hip_chat/common_methods.rb

@@ -0,0 +1,57 @@
+require "httparty"
+require_relative "error"
+
+module HipChat
+  module CommonMethods
+    BASE_URL = "http://api.hipchat.com/v2/"
+
+    OK_CODES = [
+      200,
+      201,
+      204
+    ]
+
+    private
+
+    def auth_hash
+      {auth_token: token}
+    end
+
+    def get_request(url, query_hash)
+      HTTParty.get(url, query: auth_hash.merge(query_hash))
+    end
+
+    def put_request(url, data)
+      put_or_post_data(:put, url, data)
+    end
+
+    def post_request(url, data)
+      put_or_post_data(:post, url, data)
+    end
+
+    def put_or_post_data(type, url, data)
+      HTTParty.public_send(type, url, {
+        body: data.to_json,
+        headers: {'Content-Type' => 'application/json'},
+        query: auth_hash
+      })
+    end
+
+    def deletion_request(url)
+      HTTParty.delete(url, query: auth_hash)
+    end
+
+    def validate_response(response)
+      body = response.body
+      body_hash = JSON.parse(response.body) if body
+
+      if OK_CODES.include?(response.code)
+        body_hash
+      else
+        error = body_hash["error"]
+        raise Error.new(error)
+      end
+    end
+
+  end
+end

data/lib/hip_chat/error.rb

@@ -0,0 +1,4 @@
+module HipChat
+  class Error < StandardError
+  end
+end

data/lib/hip_chat/relation.rb

@@ -0,0 +1,24 @@
+module HipChat
+  class Relation < Array
+    def initialize(token, list, list_class)
+      super(list)
+
+      @token = token
+      @list_class = list_class
+
+      self.map! do |element|
+        list_class.new(@token, element)
+      end
+    end
+
+    %w{
+      find
+      create
+      create!
+    }.each do |method_name|
+      define_method method_name do |*args|
+        @list_class.public_send(method_name, @token, *args)
+      end
+    end
+  end
+end

data/lib/hip_chat/user.rb

@@ -0,0 +1,131 @@
+require_relative "common_methods"
+
+module HipChat
+  class User
+    include CommonMethods
+
+    URL = BASE_URL + "user"
+
+    ATTRIBUTES = %w{
+      client
+      created
+      email
+      group
+      id
+      idle
+      is_deleted
+      is_group_admin
+      is_guest
+      is_online
+      last_active
+      links
+      mention_name
+      name
+      password
+      photo_url
+      presence
+      show
+      status
+      timezone
+      title
+      token
+      type
+      version
+      xmpp_jid
+    }
+
+    attr_accessor *ATTRIBUTES
+
+    class << self
+      # finder can be {id: id}, {email: email}, or {mention_name: mention_name}
+
+      def find(token, finder)
+        self.new(token, finder, fetch_details: true)
+      end
+
+      def create!(token, attributes)
+        new(token, attributes).tap(&:save!)
+      end
+
+      def create(token, attributes)
+        begin
+          create!(token, attributes)
+        rescue Error
+          false
+        end
+      end
+    end
+
+    def details
+      response = get_request(url, auth_hash)
+      properties_hash = validate_response(response)
+      set_properties(properties_hash)
+    end
+
+    def save!
+      if id.nil?
+        response = post_request(URL, hash_for_update)
+        validate_response(response)
+        true
+      else
+        update!
+      end
+    end
+
+    def update!
+      response = put_request(url, hash_for_update)
+      validate_response(response)
+      details
+      true
+    end
+
+    def destroy!
+      response = deletion_request(url)
+      validate_response(response)
+      true
+    end
+
+    {
+      destroy: "destroy!",
+      save: "save!",
+      update: "update!"
+    }.each do |rescuer, breaker|
+      define_method rescuer do
+        begin
+          send(breaker)
+        rescue Error => @error
+          false
+        end
+      end
+    end
+
+    private
+
+    def initialize(token, properties_hash, opts={})
+      @token = token
+      set_properties(properties_hash)
+      details if opts[:fetch_details]
+    end
+
+    def url
+      attr = id || email || "@#{mention_name}"
+      URL + "/" + attr.to_s
+    end
+
+    def set_properties(hash)
+      hash.each do |key, value|
+        var_name = "@#{key}"
+        self.instance_variable_set(var_name, value)
+      end
+
+      self
+    end
+
+    def hash_for_update
+      ATTRIBUTES.each_with_object({}) do |method, hash|
+        next unless value = public_send(method)
+        hash[method] = value
+      end
+    end
+  end
+end

data/lib/hip_chat/version.rb

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

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: hip_chat
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Syed Humza Shah
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  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: webmock
+  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: Easily communicate with HipChat using via their API's v2.
+email:
+- humzashah+github@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .ruby-gemset
+- .ruby-version
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- hip_chat.gemspec
+- lib/hip_chat.rb
+- lib/hip_chat/api.rb
+- lib/hip_chat/common_methods.rb
+- lib/hip_chat/error.rb
+- lib/hip_chat/relation.rb
+- lib/hip_chat/user.rb
+- lib/hip_chat/version.rb
+homepage: https://github.com/humzashah/hip_chat
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.3
+signing_key: 
+specification_version: 4
+summary: Use Ruby to control HipChat.
+test_files: []