groovehq 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5297d2c40416cd886269a0843c1fb532d23c25c6
+  data.tar.gz: bec7bed50a2eb6e43dd9186de38757bee6a23dce
+SHA512:
+  metadata.gz: 951ce20a379d848d1cfffbfd32d1585e7ee4d74f9693de5b04b3389f411c35ccf37c37af71822805c0a52a48034344ea4e55a7ec0d47c328ccfce6e67e89206a
+  data.tar.gz: c0aea7da762427a4f8851e7a2904f03ba8c38a4087b7972574ac9eee1f6e06a81d6ddb357e63d1a9e2231c82bdf8a0d1eeeae135e6faf07efbaaeffbae653772

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+cache: bundler
+script: bundle exec rspec spec
+rvm:
+  -  2.1.4

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+group :test do
+  gem 'rspec'
+  gem 'webmock'
+end
+
+# Specify your gem's dependencies in groovehq.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Kirill Shirinkin
+
+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,3 @@
+### GrooveHQ ruby client library
+
+[![Build Status](https://travis-ci.org/Fodoj/groovehq.svg)](https://travis-ci.org/Fodoj/groovehq)

data/Rakefile

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

data/groovehq.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'groovehq/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "groovehq"
+  spec.version       = GrooveHQ::VERSION
+  spec.authors       = ["Kirill Shirinkin"]
+  spec.email         = ["fodojyko@gmail.com"]
+  spec.summary       = %q{Client library for GrooveHQ API.}
+  spec.description   = %q{Client library for GrooveHQ API.}
+  spec.homepage      = "https://github.com/Fodoj/groovehq"
+  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_dependency "httparty"
+  spec.add_dependency "activesupport"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/groovehq.rb

@@ -0,0 +1,11 @@
+require "active_support/core_ext/hash"
+require "httparty"
+require "groovehq/version"
+require "groovehq/relation"
+require "groovehq/resource"
+require "groovehq/resource_collection"
+require "groovehq/client"
+
+module GrooveHQ
+  # Your code goes here...
+end

data/lib/groovehq/client.rb

@@ -0,0 +1,34 @@
+require "groovehq/client/connection"
+
+require "groovehq/client/agents"
+require "groovehq/client/customers"
+require "groovehq/client/folders"
+require "groovehq/client/groups"
+require "groovehq/client/mailboxes"
+require "groovehq/client/messages"
+require "groovehq/client/tickets"
+require "groovehq/client/webhooks"
+
+module GrooveHQ
+  class Client
+    include HTTParty
+    include GrooveHQ::Client::Connection
+    include GrooveHQ::Client::Agents
+    include GrooveHQ::Client::Customers
+    include GrooveHQ::Client::Folders
+    include GrooveHQ::Client::Groups
+    include GrooveHQ::Client::Mailboxes
+    include GrooveHQ::Client::Messages
+    include GrooveHQ::Client::Tickets
+    include GrooveHQ::Client::Webhooks
+
+    base_uri "https://api.groovehq.com/v1"
+    format :json
+
+    def initialize(access_token = nil)
+      access_token ||= ENV["GROOVEHQ_ACCESS_TOKEN"]
+      self.class.default_options.merge!(headers: { 'Authorization' => "Bearer #{access_token}" })
+    end
+
+  end
+end

data/lib/groovehq/client/agents.rb

@@ -0,0 +1,17 @@
+module GrooveHQ
+  class Client
+
+    module Agents
+
+      def agent(email)
+        get("/agents/#{email}")
+      end
+
+      def agents(options = {})
+        get("/agents", options)
+      end
+
+    end
+
+  end
+end

data/lib/groovehq/client/connection.rb

@@ -0,0 +1,52 @@
+module GrooveHQ
+
+  class Client
+
+    module Connection
+
+      def get(path, options = {})
+        request :get, path, options
+      end
+
+      def post(path, options = {})
+        request :post, path, options
+      end
+
+      def put(path, options = {})
+        request :put, path, options
+      end
+
+      def delete(path, options = {})
+        request :delete, path, options
+      end
+
+      private
+
+      def request(http_method, path, options)
+        response = self.class.send(http_method, path, { query: options })
+        data = response.parsed_response
+        parse_data(data)
+      end
+
+      def parse_data(original_data)
+        return unless original_data
+
+        # This hack is added primaraly to deal with API response inconsistencies:
+        # https://www.groovehq.com/docs/ticket-counts#listing-ticket-counts (one key per folder)
+        # https://www.groovehq.com/docs/tickets#listing-tickets (has two keys: 'tickets' and 'meta')
+        # https://www.groovehq.com/docs/tickets#finding-one-ticket (one key: 'ticket')
+        # :(
+        data = original_data.keys.count <= 2 ? original_data.values.first : original_data
+
+        case data
+        when Hash  then Resource.new(self, data)
+        when Array then ResourceCollection.new(self, original_data)
+        when nil   then nil
+        else data
+        end
+      end
+
+    end
+
+  end
+end

data/lib/groovehq/client/customers.rb

@@ -0,0 +1,21 @@
+module GrooveHQ
+  class Client
+
+    module Customers
+
+      def update_customer(options)
+        post("/tickets/#{ticket_number}/messages", options)
+      end
+
+      def customer(email)
+        get("/customers/#{email}")
+      end
+
+      def customers(options = {})
+        get("/customers", options)
+      end
+
+    end
+
+  end
+end

data/lib/groovehq/client/folders.rb

@@ -0,0 +1,14 @@
+module GrooveHQ
+  class Client
+
+    module Folders
+
+      # Doesn't work, waiting for GrooveHQ team to clarify
+      def folders(options = {})
+        get("/folders", options)
+      end
+
+    end
+
+  end
+end

data/lib/groovehq/client/groups.rb

@@ -0,0 +1,13 @@
+module GrooveHQ
+  class Client
+
+    module Groups
+
+      def groups(options = {})
+        get("/groups", options)
+      end
+
+    end
+
+  end
+end

data/lib/groovehq/client/mailboxes.rb

@@ -0,0 +1,13 @@
+module GrooveHQ
+  class Client
+
+    module Mailboxes
+
+      def mailboxes(options = {})
+        get("/mailboxes", options)
+      end
+
+    end
+
+  end
+end

data/lib/groovehq/client/messages.rb

@@ -0,0 +1,21 @@
+module GrooveHQ
+  class Client
+
+    module Messages
+
+      def create_message(options)
+        post("/tickets/#{ticket_number}/messages", options)
+      end
+
+      def message(message_id)
+        get("/messages/#{message_id}")
+      end
+
+      def messages(ticket_number, options = {})
+        get("/tickets/#{ticket_number}/messages", options)
+      end
+
+    end
+
+  end
+end

data/lib/groovehq/client/tickets.rb

@@ -0,0 +1,50 @@
+module GrooveHQ
+  class Client
+
+    module Tickets
+
+      # FIXME Doesn't work yet, shows only one random folder at the moment
+      def tickets_count(options = {})
+        get("/tickets/count", options)
+      end
+
+      def create_ticket(options)
+        post("/tickets", options)
+      end
+
+      def ticket(ticket_number)
+        get("/tickets/#{ticket_number}")
+      end
+
+      def tickets(options = {})
+        get("/tickets", options)
+      end
+
+      def ticket_state(ticket_number)
+        get("/tickets/#{ticket_number}/state")
+      end
+
+      def update_ticket_state(ticket_number, state)
+        put("/tickets/#{ticket_number}/state", state: state)
+      end
+
+      def ticket_assignee(ticket_number)
+        get("/tickets/#{ticket_number}/assignee")
+      end
+
+      def update_ticket_assignee(ticket_number, assignee)
+        put("/tickets/#{ticket_number}/assignee", assignee: assignee)
+      end
+
+      def update_ticket_priority(ticket_number, priority)
+        put("/tickets/#{ticket_number}/assignee", priority: priority)
+      end
+
+      def update_ticket_assigned_group(ticket_number, assigned_group)
+        put("/tickets/#{ticket_number}/assigned_group", assigned_group: assigned_group)
+      end
+
+    end
+
+  end
+end

data/lib/groovehq/client/webhooks.rb

@@ -0,0 +1,17 @@
+module GrooveHQ
+  class Client
+
+    module Webhooks
+
+      def create_webhook(options)
+        post("/webhooks", options)
+      end
+
+      def delete_webhook(id)
+        delete("/webhooks/#{id}")
+      end
+
+    end
+
+  end
+end

data/lib/groovehq/relation.rb

@@ -0,0 +1,11 @@
+module GrooveHQ
+
+  class Relation < Struct.new(:client, :href)
+
+    def get(options = {})
+      client.get href, options
+    end
+
+  end
+
+end

data/lib/groovehq/resource.rb

@@ -0,0 +1,37 @@
+module GrooveHQ
+
+  class Resource
+    attr_reader :rels, :data
+
+    def initialize(client, data)
+      data = {} unless data.is_a?(Hash)
+
+      @client = client
+
+      data = data.with_indifferent_access
+
+      links        = data.delete(:links) { Hash.new }
+      links[:self] = data.delete(:href) if data.has_key?(:href)
+
+      @data   = OpenStruct.new(data.with_indifferent_access)
+
+      @rels = parse_links(links).with_indifferent_access
+    end
+
+    def parse_links(links)
+      (links || {}).each_with_object({}) do |(relation, value), result|
+        result[relation] = Relation.new(@client, value["href"])
+      end
+    end
+
+    def method_missing(method_sym, *arguments, &block)
+      if @data.respond_to?(method_sym)
+        @data.send(method_sym)
+      else
+        super
+      end
+    end
+
+  end
+
+end

data/lib/groovehq/resource_collection.rb

@@ -0,0 +1,39 @@
+module GrooveHQ
+
+  class ResourceCollection < Resource
+    include Enumerable
+
+    def initialize(client, data)
+      data = {} unless data.is_a?(Hash)
+      data = data.with_indifferent_access
+
+      meta_data = data.delete(:meta) { Hash.new }
+
+      collection = Array(data.values.first).map do |item|
+        Resource.new(client, item)
+      end
+
+      links = {}
+
+      if meta_data.has_key?("pagination")
+        links = {
+          next: {
+            href: meta_data["pagination"]["next_page"]
+          },
+          prev: {
+            href: meta_data["pagination"]["prev_page"]
+          }
+        }
+      end
+
+      @data = OpenStruct.new(meta: meta_data, collection: collection)
+      @rels = parse_links(links).with_indifferent_access
+    end
+
+    def each(&block)
+      collection.each { |item| yield item }
+    end
+
+  end
+
+end

data/lib/groovehq/version.rb

@@ -0,0 +1,3 @@
+module GrooveHQ
+  VERSION = "1.0.0"
+end

data/spec/groovehq/client/connection_spec.rb

@@ -0,0 +1,110 @@
+require 'spec_helper'
+
+describe GrooveHQ::Client::Connection do
+
+  let(:client) { GrooveHQ::Client.new("phantogram") }
+
+  it "returns nil for empty response" do
+    stub_request(:get, "https://api.groovehq.com/v1/tickets").to_return(body: "")
+    expect(client.get("/tickets")).to eql(nil)
+  end
+
+  context "nested hash as response with single root key" do
+
+    let(:response) do
+      {
+        ticket: {
+          number: 1,
+          summary: "This is the first 100 characters of the first message...",
+          links: {
+            assignee: {
+              href: "https://api.groovehq.com/v1/agents/matt@groovehq.com"
+            }
+          }
+        }
+      }.to_json
+    end
+
+    before(:each) do
+      stub_request(:get, "https://api.groovehq.com/v1/tickets/1").to_return(body: response)
+    end
+
+    it "returns resource for single root key" do
+      expect(client.get("/tickets/1")).to be_instance_of(GrooveHQ::Resource)
+    end
+
+    it "returns resource with correct relations" do
+      expect(client.get("/tickets/1").rels[:assignee].href).to eql("https://api.groovehq.com/v1/agents/matt@groovehq.com")
+    end
+
+  end
+
+  context "single key-value pair in response" do
+
+    let(:response) do
+      { state: "open" }.to_json
+    end
+
+    before(:each) do
+      stub_request(:get, "https://api.groovehq.com/v1/tickets/1/state").to_return(body: response)
+    end
+
+    it "returns response as it is" do
+      expect(client.get("/tickets/1/state")).to eql "open"
+    end
+
+  end
+
+  context "multiple root key-value pairs in response" do
+
+    let(:response) do
+      {
+        "728525" => 1,
+        "987452" => 0,
+        "842376" => 0
+      }.to_json
+    end
+
+    before(:each) do
+      stub_request(:get, "https://api.groovehq.com/v1/tickets/count").to_return(body: response)
+    end
+
+    it "returns response as it is" do
+      expect(client.get("/tickets/count").data.to_h.keys.count).to eql 3
+    end
+
+  end
+
+  context "array of hashes in response" do
+
+    let(:response) do
+      {
+        tickets: [
+          { number: 1 },
+          { number: 2 },
+          { number: 3 }
+        ],
+        meta: {
+          pagination: {
+            next_page: "https://api.groovehq.com/v1/tickets/?page=2",
+            prev_page: nil
+          }
+        }
+      }.to_json
+    end
+
+    before(:each) do
+      stub_request(:get, "https://api.groovehq.com/v1/tickets").to_return(body: response)
+    end
+
+    it "builds array of resources from response" do
+      expect(client.get("/tickets").data[:collection].count).to eql 3
+    end
+
+    it "returns relations for pagination" do
+      expect(client.get("/tickets").rels[:next]).to be_instance_of(GrooveHQ::Relation)
+    end
+
+  end
+
+end

data/spec/groovehq/resource_collection_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+describe GrooveHQ::Resource do
+
+  let(:client) { GrooveHQ::Client.new("phantogram") }
+
+  context "#data" do
+
+    it "returns empty data for invalid input" do
+      resource = GrooveHQ::ResourceCollection.new(self, "")
+      expect(resource.count).to eql(0)
+    end
+
+    it "parses data correctly" do
+      data = {
+        tickets: [ { name: "When I am small" } ]
+      }
+      resource = GrooveHQ::ResourceCollection.new(self, data)
+      expect(resource.first.name).to eql "When I am small"
+    end
+
+  end
+
+  context "#rels" do
+
+    it "parses relations correctly" do
+      data = {
+        tickets: [],
+        meta: {
+          pagination: {
+            current_page: 1,
+            total_pages: 23,
+            total_count: 23,
+            next_page: "http://api.groovehq.dev/v1/tickets?page=2"
+          }
+        }
+      }
+      resource = GrooveHQ::ResourceCollection.new(self, data)
+      expect(resource.rels[:next]).to be_instance_of(GrooveHQ::Relation)
+    end
+
+  end
+
+end

data/spec/groovehq/resource_spec.rb

@@ -0,0 +1,55 @@
+require 'spec_helper'
+
+describe GrooveHQ::Resource do
+
+  let(:client) { GrooveHQ::Client.new("phantogram") }
+
+  context "#data" do
+
+    it "returns empty data for invalid input" do
+      resource = GrooveHQ::Resource.new(self, "")
+      expect(resource.data.to_h).to eql({})
+    end
+
+    it "parses data correctly" do
+      data = {
+        name: "When I am small"
+      }
+      resource = GrooveHQ::Resource.new(self, data)
+      expect(resource.data[:name]).to eql "When I am small"
+    end
+
+    it "adds getters for data" do
+      data = {
+        name: "When I am small"
+      }
+      resource = GrooveHQ::Resource.new(self, data)
+      expect(resource.name).to eql "When I am small"
+    end
+  end
+
+  context "#rels" do
+
+    it "parses relations correctly" do
+      data = {
+        links: {
+          assignee: {
+            href: "https://api.groovehq.com/v1/agents/matt@groovehq.com"
+          }
+        }
+      }
+      resource = GrooveHQ::Resource.new(self, data)
+      expect(resource.rels[:assignee]).to be_instance_of(GrooveHQ::Relation)
+    end
+
+    it "parses self relation correctly" do
+      data = {
+        href: "https://api.groovehq.com/v1/agents/matt@groovehq.com"
+      }
+      resource = GrooveHQ::Resource.new(self, data)
+      expect(resource.rels[:self]).to be_instance_of(GrooveHQ::Relation)
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require 'webmock/rspec'
+require_relative '../lib/groovehq'
+
+RSpec.configure do |config|
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: groovehq
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Kirill Shirinkin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-07-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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'
+description: Client library for GrooveHQ API.
+email:
+- fodojyko@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- groovehq.gemspec
+- lib/groovehq.rb
+- lib/groovehq/client.rb
+- lib/groovehq/client/agents.rb
+- lib/groovehq/client/connection.rb
+- lib/groovehq/client/customers.rb
+- lib/groovehq/client/folders.rb
+- lib/groovehq/client/groups.rb
+- lib/groovehq/client/mailboxes.rb
+- lib/groovehq/client/messages.rb
+- lib/groovehq/client/tickets.rb
+- lib/groovehq/client/webhooks.rb
+- lib/groovehq/relation.rb
+- lib/groovehq/resource.rb
+- lib/groovehq/resource_collection.rb
+- lib/groovehq/version.rb
+- spec/groovehq/client/connection_spec.rb
+- spec/groovehq/resource_collection_spec.rb
+- spec/groovehq/resource_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/Fodoj/groovehq
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Client library for GrooveHQ API.
+test_files:
+- spec/groovehq/client/connection_spec.rb
+- spec/groovehq/resource_collection_spec.rb
+- spec/groovehq/resource_spec.rb
+- spec/spec_helper.rb
+has_rdoc: