desk_api_v2 0.0.1 → 0.0.2

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    Y2JlYzYyMDg5NzcwZWRhMjc3M2JmZDY5OTkyNDBkNGZhN2UyMzk5ZQ==
+    NDUzZTQwZDBkMWI0NzkzMjg0ZjYwZGNiMDdhZTI1MTI0YjhkNGE1Mg==
   data.tar.gz: !binary |-
-    YWU0Yzk0YzhiZWQ0MDUyN2Q3MTk5NzczMDJjNjgzNDJjMzJmNjA2Ng==
+    YzgzYmZmNjQyNDVjOThjYjE5YWYyYjVhZWRiNjNhOGY4OGYwMmM5OA==
 SHA512:
   metadata.gz: !binary |-
-    NjhjYjg1MDA0YTE2Y2NjMTZlNmQ5NTk0M2ZkMTJmYjE1ZjYxYjMxYjVjNWNm
-    MzhjNGRkOGVjZWFhMGRmNzY4NzY3MDM0N2JkMjFkNTc3NDBkYTc1ODBiNDUx
-    NTkzOTIyMzJiMGQzZTc5N2YxMTA5YzIxMTAwOGMzNDMxOTVmYjY=
+    NzBhNGI0M2UxZWY1ZjJmNGYzODA4OGJlYzdmYmQ2MmFhZWE5NWFjYmNiNGM5
+    ODg2NWIyY2Y5NTc0MmQyNDBkYTgxYzkwMGM1ZThhNzQxMTZhNjA2Yzk4MjNm
+    OTVkMzY4ZjZkOTYxYTU2NjQyYmFkMWEyYWRkODhlZGI4ZTM4MGU=
   data.tar.gz: !binary |-
-    YTI1OGQzZTQ1OWYzZjFiZDgwNWY5MjlhNGZjYTEyNjllYzUyNzM0MDE0NDA1
-    MmNlMTQyODcwNTkyZDEyNGU5YWM2ODMzODYxZjEwMjA5OGY3MzQzYjE5ODU0
-    MWUxMzNmZThmNzU3ZTc4NGVjZWVkMTNkN2ZkNjcwOTZhOGQ2NTU=
+    OTM0M2MyZDAwNmQ2NTNmN2VjOGFiOWY2ZmVmYWI3ZTBhMDU4NWJiYzhiODkz
+    MDdiMGQ2MDA3YmNiMTZhMGZjMWVjNjQwMDc1NzNhOTQ2M2JlY2Y2NWVhNGI2
+    MWIxZGMzNjk1ZmZhMDcxMjliNWVmMGZlNmQ0ZWIwZGE4YWYyNGE=

data/.gitignore

@@ -1 +1,2 @@
-Gemfile.lock
+Gemfile.lock
+*.gem

data/Rakefile

@@ -1,4 +1,5 @@
 require 'rake/testtask'
+require 'bump/tasks'
 
 begin
   require "bundler"

data/desk_api_v2.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name                     = "desk_api_v2"
-  s.version                  = "0.0.1"
+  s.version                  = "0.0.2"
   s.platform                 = Gem::Platform::RUBY
   s.authors                  = ["Justin Powers"]
   s.email                    = ["justinspowers@gmail.com"]
@@ -24,4 +24,5 @@ Gem::Specification.new do |s|
   s.add_development_dependency "webmock", "~> 1.11.0"
   s.add_development_dependency "minitest", "~> 3.5.0"
   s.add_development_dependency "minitest-reporters", "~> 0.14.20"
+  s.add_development_dependency "bump"
 end

data/lib/desk.rb

@@ -9,3 +9,5 @@ require 'desk/customer'
 require 'desk/topic'
 require 'desk/group'
 require 'desk/filter'
+require 'desk/brand'
+require 'desk/company'

data/lib/desk/api/brands.rb

@@ -0,0 +1,19 @@
+require 'desk/api/modules/listable'
+require 'desk/brand'
+
+module Desk
+  module Api
+    class Brands
+
+      include Desk::Api::Listable
+
+      attr_reader :connection, :endpoint, :return_class
+
+      def initialize(connection)
+        @connection = connection
+        @endpoint = "brands"
+        @return_class = Desk::Brand
+      end
+    end
+  end
+end

data/lib/desk/api/cases.rb

@@ -19,7 +19,7 @@ module Desk
                             :assigned_user, :channels, :notes, :attachments,
                             :case_custom_key, :created, :updated, :since_created_at,
                             :max_created_at, :since_updated_at, :max_updated_at,
-                            :since_id, :max_id]
+                            :since_id, :max_id, :q]
 
       attr_reader :connection, :endpoint, :return_class
 

data/lib/desk/api/companies.rb

@@ -0,0 +1,36 @@
+# require 'active_support/core_ext/hash'
+require 'desk/api/modules/listable'
+require 'desk/api/modules/creatable'
+require 'desk/api/modules/searchable'
+require 'desk/company'
+
+module Desk
+  module Api
+    class Companies
+
+      include Desk::Api::Listable
+      include Desk::Api::Creatable
+      include Desk::Api::Searchable
+
+      VALID_SEARCH_PARAMS= [:q]
+
+      attr_reader :connection, :endpoint, :return_class
+
+      def initialize(connection)
+        @connection = connection
+        @endpoint = "companies"
+        @return_class = Desk::Company
+      end
+
+      def cases(id)
+        Desk::Collection.new(connection.get("companies/#{id}/cases"), Desk::Case)
+      end
+
+      private
+
+      def valid_search_params
+        VALID_SEARCH_PARAMS
+      end
+    end
+  end
+end

data/lib/desk/brand.rb

@@ -0,0 +1,7 @@
+require 'desk/entity'
+
+module Desk
+  class Brand < Entity
+
+  end
+end

data/lib/desk/client.rb

@@ -5,6 +5,8 @@ require 'desk/api/translations'
 require 'desk/api/customers'
 require 'desk/api/topics'
 require 'desk/api/groups'
+require 'desk/api/brands'
+require 'desk/api/companies'
 
 module Desk
   class Client
@@ -29,6 +31,14 @@ module Desk
       Desk::Api::Topics.new(connection)
     end
 
+    def brands
+      Desk::Api::Brands.new(connection)
+    end
+
+    def companies
+      Desk::Api::Brands.new(connection)
+    end
+
     private
 
     def connection

data/lib/desk/company.rb

@@ -0,0 +1,7 @@
+require 'desk/entity'
+
+module Desk
+  class Company < Entity
+
+  end
+end

data/spec/assertions.rb

@@ -0,0 +1,25 @@
+module MiniTest::Assertions
+
+  def assert_connects_to_endpoint(endpoint, opts={})
+    fixture = opts[:fixture]
+    method = opts[:method] || :get
+
+    @connection.expect(method, fixture, [endpoint])
+    @result = yield
+    @connection.verify
+  end
+
+  def assert_returns_array_of(obj_class, opts={}, &blk)
+    assert_connects_to_endpoint(opts[:endpoint], fixture: opts[:fixture], &blk)
+
+    assert @result.is_a? Array
+    assert @result.first.is_a? obj_class
+  end
+
+  def assert_returns_one_of(obj_class, opts={}, &blk)
+    assert_connects_to_endpoint(opts[:endpoint], fixture: opts[:fixture], &blk)
+
+    assert @result.is_a? obj_class
+
+  end
+end

data/spec/desk/api/brands_spec.rb

@@ -0,0 +1,32 @@
+require 'json'
+require_relative '../../spec_helper'
+
+class BrandsSpec
+  describe Desk::Api::Brands do
+
+    before { @connection = Minitest::Mock.new }
+
+    subject { Desk::Api::Brands.new(@connection) }
+
+    describe "#all" do
+
+      it "will return an array of brands" do
+        assert_returns_array_of(Desk::Brand, endpoint: "brands", fixture: brands_fixture) { subject.all }
+      end
+    end
+
+    describe "#show" do
+      it "will return a single brand object" do
+        assert_returns_one_of(Desk::Brand, endpoint: "brands/1234", fixture: brand_fixture) { subject.show(1234) }
+      end
+    end
+
+    def brands_fixture
+      JSON.load(fixture("brands.json"))
+    end
+
+    def brand_fixture
+      JSON.load(fixture("brand.json"))
+    end
+  end
+end

data/spec/desk/api/companies_spec.rb

@@ -0,0 +1,97 @@
+require 'json'
+require_relative '../../spec_helper'
+
+class CompaniesSpec
+  describe Desk::Api::Companies do
+
+    before { @connection = Minitest::Mock.new }
+
+    subject { Desk::Api::Companies.new(@connection) }
+
+    describe "#all" do
+
+      it "will return an array of brands" do
+        assert_returns_array_of(Desk::Company, endpoint: "companies", fixture: companies_fixture) { subject.all }
+      end
+    end
+
+    describe "#show" do
+      it "will return a single company object" do
+        assert_returns_one_of(Desk::Company, endpoint: "companies/1234", fixture: company_fixture) { subject.show(1234) }
+      end
+    end
+
+    describe "#create" do
+
+      before do
+        @connection.expect(:post, company_fixture, ["companies", company_create_fixture])
+      end
+
+      it "will connect to the case creation endpoint" do
+        subject.create(company_create_fixture)
+
+        @connection.verify
+      end
+    end
+
+    describe "#update" do
+      before do
+        @connection.expect(:patch, company_fixture, ["companies/1234", company_update_fixture])
+      end
+
+      it "will connect to the case update endpoint" do
+        subject.update(1234, company_update_fixture)
+
+        @connection.verify
+      end
+    end
+
+    describe "#search" do
+
+      it "will pass whitelisted params into the search query" do
+        @connection.expect(:get, companies_fixture, ["companies/search", {q: "foo"}])
+
+        subject.search(q: "foo")
+
+        @connection.verify
+      end
+
+      it "will whitelist hash arguments" do
+        @connection.expect(:get, companies_fixture, ["companies/search", {q: "foo"}])
+
+        subject.search(q: "foo", bar: "baz")
+
+        @connection.verify
+      end
+    end
+
+    describe "#cases" do
+
+      before { @connection.expect(:get, cases_fixture, ["companies/1234/cases"]) }
+
+      it "will return an array of cases" do
+        assert_returns_array_of(Desk::Case, endpoint: "companies/1234/cases", fixture: cases_fixture) { subject.cases(1234) }
+      end
+    end
+
+    def companies_fixture
+      JSON.load(fixture("companies.json"))
+    end
+
+    def company_fixture
+      JSON.load(fixture("company.json"))
+    end
+
+    def company_create_fixture
+      JSON.load(fixture("company_create.json"))
+    end
+
+    def company_update_fixture
+      JSON.load(fixture("company_update.json"))
+    end
+
+    def cases_fixture
+      JSON.load(fixture("cases.json"))
+    end
+  end
+end

data/spec/fixtures/brand.json

@@ -0,0 +1,11 @@
+{
+  "name": "Desk.com",
+  "created_at": "2014-01-20T21:33:58Z",
+  "updated_at": "2014-01-20T21:33:58Z",
+  "_links": {
+    "self": {
+      "href": "/api/v2/brands/1",
+      "class": "brand"
+    }
+  }
+}

data/spec/fixtures/brands.json

@@ -0,0 +1,45 @@
+{
+  "total_entries": 2,
+  "_links": {
+    "self": {
+      "href": "/api/v2/brands?page=1&per_page=50",
+      "class": "page"
+    },
+    "first": {
+      "href": "/api/v2/brands?page=1&per_page=50",
+      "class": "page"
+    },
+    "last": {
+      "href": "/api/v2/brands?page=1&per_page=50",
+      "class": "page"
+    },
+    "next": null,
+    "previous": null
+  },
+  "_embedded": {
+    "entries": [
+      {
+        "name": "Desk.com",
+        "created_at": "2014-01-20T21:33:58Z",
+        "updated_at": "2014-01-20T21:33:58Z",
+        "_links": {
+          "self": {
+            "href": "/api/v2/brands/1",
+            "class": "brand"
+          }
+        }
+      },
+      {
+        "name": "Alpha Inc",
+        "created_at": "2014-01-20T21:33:58Z",
+        "updated_at": "2014-01-20T21:33:58Z",
+        "_links": {
+          "self": {
+            "href": "/api/v2/brands/2",
+            "class": "brand"
+          }
+        }
+      }
+    ]
+  }
+}

data/spec/fixtures/companies.json

@@ -0,0 +1,75 @@
+{
+  "total_entries": 2,
+  "_links": {
+    "self": {
+      "href": "/api/v2/companies?page=1&per_page=50",
+      "class": "page"
+    },
+    "first": {
+      "href": "/api/v2/companies?page=1&per_page=50",
+      "class": "page"
+    },
+    "last": {
+      "href": "/api/v2/companies?page=1&per_page=50",
+      "class": "page"
+    },
+    "next": null,
+    "previous": null
+  },
+  "_embedded": {
+    "entries": [
+      {
+        "name": "Acme Inc",
+        "domains": [
+          "acmeinc.com",
+          "acmeinc.net"
+        ],
+        "created_at": "2014-01-21T21:10:53Z",
+        "updated_at": "2014-01-21T21:10:53Z",
+        "custom_fields": {
+          "employer_id": "123456789"
+        },
+        "_links": {
+          "self": {
+            "href": "/api/v2/companies/1",
+            "class": "company"
+          },
+          "customers": {
+            "href": "/api/v2/companies/1/customers",
+            "class": "customer"
+          },
+          "cases": {
+            "href": "/api/v2/companies/1/cases",
+            "class": "case"
+          }
+        }
+      },
+      {
+        "name": "Desk.com",
+        "domains": [
+          "desk.com",
+          "salesforce.com"
+        ],
+        "created_at": "2014-01-21T21:10:53Z",
+        "updated_at": "2014-01-21T21:10:53Z",
+        "custom_fields": {
+          "employer_id": "123456789"
+        },
+        "_links": {
+          "self": {
+            "href": "/api/v2/companies/2",
+            "class": "company"
+          },
+          "customers": {
+            "href": "/api/v2/companies/2/customers",
+            "class": "customer"
+          },
+          "cases": {
+            "href": "/api/v2/companies/2/cases",
+            "class": "case"
+          }
+        }
+      }
+    ]
+  }
+}

data/spec/fixtures/company.json

@@ -0,0 +1,26 @@
+{
+  "name": "Acme Inc",
+  "domains": [
+    "acmeinc.com",
+    "acmeinc.net"
+  ],
+  "created_at": "2014-01-21T21:10:53Z",
+  "updated_at": "2014-01-21T21:10:53Z",
+  "custom_fields": {
+    "employer_id": "123456789"
+  },
+  "_links": {
+    "self": {
+      "href": "/api/v2/companies/1",
+      "class": "company"
+    },
+    "customers": {
+      "href": "/api/v2/companies/1/customers",
+      "class": "customer"
+    },
+    "cases": {
+      "href": "/api/v2/companies/1/cases",
+      "class": "case"
+    }
+  }
+}

data/spec/fixtures/company_create.json

@@ -0,0 +1,10 @@
+{
+  "name": "Acme Inc",
+  "domains": [
+    "acmeinc.com",
+    "acmeinc.net"
+  ],
+  "custom_fields": {
+    "employer_id": "123456789"
+  }
+}

data/spec/fixtures/company_update.json

@@ -0,0 +1,11 @@
+{
+  "name": "Acme Enterprises",
+  "domains": [
+    "acme-ent.com",
+    "acmeinc.com",
+    "acmeinc.net"
+  ],
+  "custom_fields": {
+    "employer_id": "987654321"
+  }
+}

data/spec/spec_helper.rb

@@ -6,6 +6,8 @@ require 'minitest/autorun'
 require 'minitest/reporters'
 require 'webmock/minitest'
 
+require_relative 'assertions'
+
 MiniTest::Reporters.use!
 
 def fixture_path

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: desk_api_v2
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Justin Powers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-21 00:00:00.000000000 Z
+date: 2014-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
@@ -108,6 +108,20 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 0.14.20
+- !ruby/object:Gem::Dependency
+  name: bump
+  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: A ruby interface to the Desk.com API V2
 email:
 - justinspowers@gmail.com
@@ -124,7 +138,9 @@ files:
 - desk_api_v2.gemspec
 - lib/desk.rb
 - lib/desk/api/articles.rb
+- lib/desk/api/brands.rb
 - lib/desk/api/cases.rb
+- lib/desk/api/companies.rb
 - lib/desk/api/customers.rb
 - lib/desk/api/groups.rb
 - lib/desk/api/modules/creatable.rb
@@ -134,9 +150,11 @@ files:
 - lib/desk/api/topics.rb
 - lib/desk/api/translations.rb
 - lib/desk/article.rb
+- lib/desk/brand.rb
 - lib/desk/case.rb
 - lib/desk/client.rb
 - lib/desk/collection.rb
+- lib/desk/company.rb
 - lib/desk/connection.rb
 - lib/desk/customer.rb
 - lib/desk/entity.rb
@@ -148,8 +166,11 @@ files:
 - lib/desk/topic.rb
 - lib/desk/translation.rb
 - lib/desk/user.rb
+- spec/assertions.rb
 - spec/desk/api/articles_spec.rb
+- spec/desk/api/brands_spec.rb
 - spec/desk/api/cases_spec.rb
+- spec/desk/api/companies_spec.rb
 - spec/desk/api/customers_spec.rb
 - spec/desk/api/groups_spec.rb
 - spec/desk/api/topics_spec.rb
@@ -158,8 +179,14 @@ files:
 - spec/desk/connection_spec.rb
 - spec/fixtures/article.json
 - spec/fixtures/articles.json
+- spec/fixtures/brand.json
+- spec/fixtures/brands.json
 - spec/fixtures/case.json
 - spec/fixtures/cases.json
+- spec/fixtures/companies.json
+- spec/fixtures/company.json
+- spec/fixtures/company_create.json
+- spec/fixtures/company_update.json
 - spec/fixtures/customer.json
 - spec/fixtures/customers.json
 - spec/fixtures/group.json