gittr 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 891bc0ea1a2d59ebe24fe96383e2f54e7642c965
+  data.tar.gz: f86daba7ffadd9d72cf0252f7aba58cb50961de6
+SHA512:
+  metadata.gz: 551dc7554d6d07e7192eacf6f43018733bf01ab75eb55c620ed7745f22dee7b0e183f5d91c41affef587375adb2845c0b9179c0ebca1d412f8c1776d8f1360c4
+  data.tar.gz: f4bfab4ff79b139f3d51b49cbbd73b14253921a33db9125db036856f2021836a47808d1dd2e72f8f70fdc8227dc477de986f5faab04c006a24fa5e3182c0d340

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Tyler Ewing
+
+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,43 @@
+# Gittr
+
+[![Code Climate](https://codeclimate.com/github/zoso10/Gittr/badges/gpa.svg)](https://codeclimate.com/github/zoso10/Gittr) [![Test Coverage](https://codeclimate.com/github/zoso10/Gittr/badges/coverage.svg)](https://codeclimate.com/github/zoso10/Gittr)
+[![Circle CI](https://circleci.com/gh/zoso10/Gittr.svg?style=svg)](https://circleci.com/gh/zoso10/Gittr)
+
+Gittr is a Ruby wrapper for the Gitter chat client REST API. Check out [Gitter](https://gitter.im/) if you haven't already!
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'gittr'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install gittr
+
+## Usage
+
+Creating a client with your API token.
+
+```ruby
+Gittr.configure do |config|
+  config.token = 'abc123'
+end
+client = Gittr::Client.new
+```
+
+The `Gittr::Client` implements all endpoints as described in the [Gitter Documentation](https://developer.gitter.im/docs/rest-api) for the REST API.
+
+## Contributing
+
+1. Fork it ( https://github.com/zoso10/gittr/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 a new Pull Request

data/Rakefile

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

data/circle.yml

@@ -0,0 +1,8 @@
+machine:
+  ruby:
+    version: 2.0.0
+  environment:
+    CODECLIMATE_REPO_TOKEN: 7f60dc04d59e21c8022f8924f3b0fdf87195f03435968e89ec0850a79175349c
+dependencies:
+  pre:
+    - gem install bundler --pre

data/gittr.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'gittr/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "gittr"
+  spec.version       = Gittr::VERSION
+  spec.authors       = ["Tyler Ewing"]
+  spec.email         = ["tewing10@gmail.com"]
+  spec.summary       = %q{Gitter REST API wrapper}
+  spec.description   = %q{Gittr is a Ruby wrapper for the Gitter chat client REST API.}
+  spec.homepage      = "https://github.com/zoso10/Gittr"
+  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.required_ruby_version = ">= 2.0"
+
+  spec.add_dependency "httparty"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "vcr"
+  spec.add_development_dependency "webmock"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "codeclimate-test-reporter"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "pry-byebug"
+end

data/lib/gittr.rb

@@ -0,0 +1,23 @@
+require 'httparty'
+
+require 'gittr/version'
+require 'gittr/hash_constructor'
+require 'gittr/room'
+require 'gittr/user'
+require 'gittr/channel'
+require 'gittr/message'
+require 'gittr/organization'
+require 'gittr/repository'
+require 'gittr/client'
+
+module Gittr
+
+  class << self
+    attr_accessor :token
+
+    def configure
+      return enum_for(__callee__) unless block_given?
+      yield self
+    end
+  end
+end

data/lib/gittr/channel.rb

@@ -0,0 +1,7 @@
+module Gittr
+  class Channel
+    include HashConstructor
+
+    attr_accessor :id, :name, :topic, :uri, :one_to_one, :unread_items, :mentions, :last_access_time, :lurk, :url, :github_type, :security, :v
+  end
+end

data/lib/gittr/client.rb

@@ -0,0 +1,95 @@
+module Gittr
+  class Client
+    include HTTParty
+
+    base_uri 'https://api.gitter.im/v1/'
+
+    def initialize(token=Gittr.token)
+      @token = token
+      @headers = {"Accept" => "application/json", "Authorization" => "Bearer #{@token}", "Content-Type" => "application/json"}
+      raise StandardError.new('API Token is missing') unless @token
+    end
+
+    def rooms
+      map_get_response('/rooms'){ |room| Room.new(room) }
+    end
+
+    def rooms_users(room_id)
+      map_get_response("/rooms/#{room_id}/users"){ |user| User.new(user) }
+    end
+
+    def rooms_channels(room_id)
+      map_get_response("/rooms/#{room_id}/channels"){ |channel| Channel.new(channel) }
+    end
+
+    def join_room(uri)
+      post_response('/rooms', {uri: uri}){ |room| Room.new(room) }
+    end
+
+    def list_messages(room_id, params={})
+      map_get_response("/rooms/#{room_id}/chatMessages", params){ |message| Message.new(message) }
+    end
+
+    def create_message(room_id, text)
+      post_response("/rooms/#{room_id}/chatMessages", {}, {text: text}){ |message| Message.new(message) }
+    end
+
+    def update_message(room_id, message_id, text)
+      put_response("/rooms/#{room_id}/chatMessages/#{message_id}", {text: text}){ |message| Message.new(message) }
+    end
+
+    def get_user
+      # There's only one user in the array, silly...
+      get_response("/user"){ |user| User.new(user.first) }
+    end
+
+    def user_rooms(user_id)
+      map_get_response("/user/#{user_id}/rooms"){ |room| Room.new(room) }
+    end
+
+    def mark_as_read(user_id, room_id)
+      post_response("/user/#{user_id}/rooms/#{room_id}/unreadItems")
+    end
+
+    def user_orgs(user_id)
+      map_get_response("/user/#{user_id}/orgs"){ |org| Organization.new(org) }
+    end
+
+    def user_repos(user_id)
+      map_get_response("/user/#{user_id}/repos"){ |repo| Repository.new(repo) }
+    end
+
+    def user_channels(user_id)
+      map_get_response("/user/#{user_id}/channels"){ |channel| Channel.new(channel) }
+    end
+
+  protected
+
+    def get_response(uri, params={}, &block)
+      response = self.class.get(uri, headers: @headers, query: params)
+      response = response.parsed_response
+      return response unless block_given?
+      yield response
+    end
+
+    def map_get_response(uri, params={}, &block)
+      get_response(uri, params).map do |response|
+        yield response
+      end
+    end
+
+    def post_response(uri, params={}, body='', &block)
+      response = self.class.post(uri, headers: @headers, query: params, body: body.to_json)
+      response = response.parsed_response
+      return response unless block_given?
+      yield response
+    end
+
+    def put_response(uri, body='', &block)
+      response = self.class.put(uri, headers: @headers, body: body.to_json)
+      response = response.parsed_response
+      return response unless block_given?
+      yield response
+    end
+  end
+end

data/lib/gittr/hash_constructor.rb

@@ -0,0 +1,20 @@
+module Gittr
+  module HashConstructor
+    def initialize(args={})
+      args.each do |key, value|
+        add_instance_variable(key) unless respond_to? to_snake_case(key)
+        public_send "#{to_snake_case(key)}=", value
+      end
+    end
+
+    def to_snake_case(str)
+      str.to_s.gsub(/(.)([A-Z])/, '\1_\2').downcase
+    end
+
+  protected
+
+    def add_instance_variable(key)
+      self.class.class_eval{ attr_accessor key.to_sym }
+    end
+  end
+end

data/lib/gittr/message.rb

@@ -0,0 +1,11 @@
+module Gittr
+  class Message
+    include HashConstructor
+
+    attr_accessor :id, :text, :html, :sent, :edited_at, :from_user, :unread, :read_by, :urls, :mentions, :issues, :meta, :v, :error
+
+    def from_user=(user)
+      @from_user = User.new(user)
+    end
+  end
+end

data/lib/gittr/organization.rb

@@ -0,0 +1,7 @@
+module Gittr
+  class Organization
+    include HashConstructor
+
+    attr_accessor :id, :name, :avatar_url, :room, :premium
+  end
+end

data/lib/gittr/repository.rb

@@ -0,0 +1,11 @@
+module Gittr
+  class Repository
+    include HashConstructor
+
+    attr_accessor :id, :name, :description, :uri, :private, :exists, :avatar_url, :room
+
+    def room=(room)
+      @room = Room.new(room)
+    end
+  end
+end

data/lib/gittr/room.rb

@@ -0,0 +1,11 @@
+module Gittr
+  class Room
+    include HashConstructor
+
+    attr_accessor :id, :name, :topic, :uri, :one_to_one, :users, :user_count, :unread_items, :mentions, :last_access_time, :lurk, :url, :github_type, :security, :premium, :noindex, :v
+
+    def users=(users)
+      @users = users.map{ |user| User.new(user) }
+    end
+  end
+end

data/lib/gittr/user.rb

@@ -0,0 +1,7 @@
+module Gittr
+  class User
+    include HashConstructor
+
+    attr_accessor :id, :username, :display_name, :url, :avatar_url_small, :avatar_url_medium, :role
+  end
+end

data/lib/gittr/version.rb

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

data/spec/channel_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe Gittr::Channel do
+  subject(:channel){ Gittr::Channel.new({"id" => "asdf", "name" => "skriv", "uri" => "zoso10/skriv", "garbage" => "foo"}) }
+
+  it 'should instantiate from hash' do
+    expect(channel.id).to eq('asdf')
+    expect(channel.name).to eq('skriv')
+    expect(channel.uri).to eq('zoso10/skriv')
+  end
+end

data/spec/client_spec.rb

@@ -0,0 +1,147 @@
+require 'spec_helper'
+
+describe Gittr::Client do
+  subject(:client) { Gittr::Client.new('redacted') }
+
+  it 'should not raise an exception' do
+    expect{
+      Gittr.configure{ |config| config.token='asdf'}
+      Gittr::Client.new
+    }.not_to raise_error
+    Gittr.token = nil
+  end
+
+  it 'should return rooms' do
+    VCR.use_cassette('rooms') do
+      rooms = client.rooms
+      expect(rooms.count).to eq(1)
+      expect(rooms[0].name).to eq('zoso10/skriv')
+    end
+  end
+
+  it 'should return users for room 54b7e136db8155e6700eb569' do
+    VCR.use_cassette('rooms_users') do
+      users = client.rooms_users('54b7e136db8155e6700eb569')
+      expect(users.count).to eq(2)
+      expect(users[0].username).to eq('zoso10')
+      expect(users[0].display_name).to eq('Tyler Ewing')
+    end
+  end
+
+  it 'should return channels for room 54b7e136db8155e6700eb569' do
+    VCR.use_cassette('rooms_channels') do
+      users = client.rooms_channels('54b7e136db8155e6700eb569')
+      expect(users.count).to eq(0)
+    end
+  end
+
+  it 'should join room and be admin' do
+    VCR.use_cassette('join_room') do
+      room = client.join_room('zoso10/gittr')
+      expect(room.name).to eq('zoso10/Gittr')
+      expect(room.user_count).to eq(1)
+      expect(room.users[0].username).to eq('zoso10')
+      expect(room.users[0].display_name).to eq('Tyler Ewing')
+      expect(room.users[0].role).to eq('admin')
+    end
+  end
+
+  it 'should list messages' do
+    VCR.use_cassette('list_messages') do
+      room_id = '54b7e136db8155e6700eb569'
+      messages = client.list_messages(room_id)
+      expect(messages).to_not be_nil
+      expect(messages.count).to eq(50)
+      expect(messages[0].text).to eq('thats pretty cool')
+      expect(messages[0].from_user.username).to eq('zoso10')
+    end
+  end
+
+  it 'should only list 10 messages' do
+    VCR.use_cassette('list_messages', record: :new_episodes) do
+      room_id = '54b7e136db8155e6700eb569'
+      messages = client.list_messages(room_id, limit: 10)
+      expect(messages.count).to eq(10)
+    end
+  end
+
+  it 'sends a message' do
+    VCR.use_cassette('send_message') do
+      room_id = '54b7e136db8155e6700eb569'
+      text = 'This is a sample message'
+      message = client.create_message(room_id, text)
+      expect(message).to_not be_nil
+      expect(message.text).to eq(text)
+      expect(message.from_user.username).to eq('zoso10')
+    end
+  end
+
+  it 'update a message' do
+    VCR.use_cassette('update_message') do
+      room_id = '54b7e136db8155e6700eb569'
+      message_id = '54bd1b4a573df0f92345a00f'
+      text = 'This message has been updated'
+      message = client.update_message(room_id, message_id, text)
+      expect(message).to_not be_nil
+      expect(message.error).to eq('You can no longer edit this message')
+    end
+  end
+
+  it 'gets the current user' do
+    VCR.use_cassette('user') do
+      user = client.get_user
+      expect(user.id).to eq('54b7df5bdb8155e6700eb552')
+      expect(user.username).to eq('zoso10')
+      expect(user.display_name).to eq('Tyler Ewing')
+    end
+  end
+
+  it 'gets the rooms for the user' do
+    VCR.use_cassette('user_rooms') do
+      user_id = '54b7df5bdb8155e6700eb552'
+      rooms = client.user_rooms(user_id)
+      expect(rooms.count).to eq(2)
+      expect(rooms[0].name).to eq('zoso10/Gittr')
+      expect(rooms[0].uri).to eq('zoso10/Gittr')
+    end
+  end
+
+  it 'marks a message as read' do
+    VCR.use_cassette('read_message') do
+      user_id = '54b7df5bdb8155e6700eb552'
+      room_id = '54b7e136db8155e6700eb569'
+      something = client.mark_as_read(user_id, room_id)
+      expect(something).to_not be_nil
+    end
+  end
+
+  it 'gets the orgs for the user' do
+    VCR.use_cassette('user_orgs') do
+      user_id = '54b7df5bdb8155e6700eb552'
+      orgs = client.user_orgs(user_id)
+      expect(orgs).to_not be_nil
+      expect(orgs[0].name).to eq('thoughtbot')
+      expect(orgs[1].name).to eq('secondrotation')
+    end
+  end
+
+  it 'gets the repos for the user' do
+    VCR.use_cassette('user_repos') do
+      user_id = '54b7df5bdb8155e6700eb552'
+      repos = client.user_repos(user_id)
+      expect(repos).to_not be_nil
+      expect(repos.count).to eq(236)
+      expect(repos[0].name).to eq('thoughtbot/hound')
+      expect(repos[0].uri).to eq('thoughtbot/hound')
+    end
+  end
+
+  it 'gets the channels for the user' do
+    VCR.use_cassette('user_channels') do
+      user_id = '54b7df5bdb8155e6700eb552'
+      channels = client.user_channels(user_id)
+      expect(channels).to_not be_nil
+      expect(channels.count).to eq(0)
+    end
+  end
+end