desk 1.0.8 → 1.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6a9aa7d85fd6f664f33aa22ca041d54c50d13a13
-  data.tar.gz: d75f64fc8370b1e6535fc9db8284c4f5c6633c2f
+  metadata.gz: cf6cdb20333938ba846729b567cb0a18297354f6
+  data.tar.gz: 8a2b4d82b8e86a7fde28b53d6d9b56540c8469ba
 SHA512:
-  metadata.gz: f5a548d4329f1d30b69396a94b230f2e7bba42a75f483ab00a344eaebe23b3a6afbd3a270e3e00cfef3a907c4031724a9dacd81d008e4485ac2437078c833ce2
-  data.tar.gz: a6bff0a201abff9eccca566d88657d70f8145d7551eb3253b002918b37163a7b665cf7e3043618c7519a2bec177e2e5f4e70be20fc94cafe78d3e63622adc6e9
+  metadata.gz: 4df4acd8e57b70fccedbab77ff9f94a4e087c0775bfd88b3410bbd1791561365c1ca58fc7cab94d0f657cd841fcbaec3d71b50821680bd27d4023a7c43c24cc9
+  data.tar.gz: f55c90b816664f3d557a299e05e6934ce3b7b2a663a543b0f1593979889feb73a986c849937cac60fc7456e143c9f9af4df2f8814dc20bd4081be7583cf258b0

data/README.mkd

@@ -389,6 +389,19 @@ Usage Examples
     # Show the daily system message
     Desk.system_message
 
+    # Basic authentication with username and password; not recommended
+
+    Desk.configure do |config|
+      config.support_email = "help@example.com"
+      config.subdomain = YOUR_DESK_SUBDOMAIN
+      config.consumer_key = YOUR_CONSUMER_KEY
+      config.consumer_secret = YOUR_CONSUMER_SECRET
+      config.auth_method = Desk::Authentication::Methods:BASIC
+      config.basic_auth_username = YOUR_USERNAME
+      config.basic_auth_password = YOUR_PASSWORD
+    end
+
+
 Contributing
 ------------
 In the spirit of [free software](http://www.fsf.org/licensing/essays/free-sw.html), **everyone** is encouraged to help improve this project.

data/desk.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency('webmock', '~> 1.6')
   s.add_development_dependency('yard', '~> 0.6')
   s.add_runtime_dependency('json', '~> 1.7')  if RUBY_VERSION < '1.9'
-  s.add_runtime_dependency 'hashie', '3.4.1'
+  s.add_runtime_dependency 'hashie', '~> 3.4', '>= 3.4.2'
   s.add_runtime_dependency('faraday', '~> 0.9.0')
   s.add_runtime_dependency('faraday_middleware', '~> 0.9.0')
   s.add_runtime_dependency('jruby-openssl', '~> 0.7.2') if RUBY_PLATFORM == 'java'
@@ -27,6 +27,7 @@ Gem::Specification.new do |s|
   s.files = `git ls-files`.split("\n")
   s.homepage = 'https://github.com/zencoder/desk'
   s.name = 'desk'
+  s.license = 'MIT'
   s.platform = Gem::Platform::RUBY
   s.require_paths = ['lib']
   s.required_rubygems_version = Gem::Requirement.new('>= 1.3.6') if s.respond_to? :required_rubygems_version=

data/lib/desk/api.rb

@@ -18,7 +18,7 @@ module Desk
     end
 
     def endpoint
-      "https://#{self.subdomain}.desk.com"+api_path
+      "https://#{self.subdomain}.#{self.domain}"+api_path
     end
 
     def api_path

data/lib/desk/authentication.rb

@@ -1,12 +1,32 @@
 module Desk
   # @private
   module Authentication
+    module Methods
+      OAUTH = "oauth"
+      BASIC = "basic"
+      ALL = [
+        OAUTH,
+        BASIC,
+      ]
+    end
+
     private
 
     # Authentication hash
     #
     # @return [Hash]
     def authentication
+      if auth_method == Methods::BASIC
+        basic_authentication
+      else
+        oauth_authentication
+      end
+    end
+
+    # Authentication hash for OAUTH connections
+    #
+    # @return [Hash]
+    def oauth_authentication
       {
         :consumer_key => consumer_key,
         :consumer_secret => consumer_secret,
@@ -15,6 +35,16 @@ module Desk
       }
     end
 
+    # Authentication hash for Basic auth connections
+    #
+    # @return [Hash]
+    def basic_authentication
+      {
+        :username => basic_auth_username,
+        :password => basic_auth_password
+      }
+    end
+
     # Check whether user is authenticated
     #
     # @return [Boolean]

data/lib/desk/client/case.rb

@@ -65,7 +65,7 @@ module Desk
       end
 
       def case_url(case_id)
-        "https://#{subdomain}.desk.com/agent/case/#{case_id}"
+        "https://#{subdomain}.#{domain}/agent/case/#{case_id}"
       end
     end
   end

data/lib/desk/client/insight.rb

@@ -3,13 +3,13 @@ module Desk
     module Insight
 
       def show_insights_meta
-        get("insights/meta")
+        get("insights3/meta")
       end
       alias_method :insights_meta, :show_insights_meta
 
       def create_insights_report(*args)
         options = args.last.is_a?(Hash) ? args.pop : {}
-        post("insights/reports", options)
+        post("insights3/reports", options)
       end
 
     end

data/lib/desk/configuration.rb

@@ -1,5 +1,6 @@
 require 'faraday'
 require 'desk/version'
+require 'desk/authentication'
 
 module Desk
   # Defines constants and methods related to configuration
@@ -7,8 +8,12 @@ module Desk
     # An array of valid keys in the options hash when configuring a {Twitter::API}
     VALID_OPTIONS_KEYS = [
       :adapter,
+      :auth_method,
+      :basic_auth_username,
+      :basic_auth_password,
       :consumer_key,
       :consumer_secret,
+      :domain,
       :format,
       :logger,
       :max_requests,
@@ -32,6 +37,18 @@ module Desk
     # @note The default faraday adapter is Net::HTTP.
     DEFAULT_ADAPTER = Faraday.default_adapter
 
+    # By default, OAUTH is selected
+    DEFAULT_AUTH_METHOD = Desk::Authentication::Methods::OAUTH
+
+    # By default, don't set a username
+    DEFAULT_BASIC_AUTH_USERNAME = nil
+
+    # By default, don't set a password
+    DEFAULT_BASIC_AUTH_PASSWORD = nil
+
+    # By default, use the desk.com hosted domain
+    DEFAULT_DOMAIN = "desk.com"
+
     # By default, don't set an application key
     DEFAULT_CONSUMER_KEY = nil
 
@@ -75,6 +92,7 @@ module Desk
     # By default, don't set a support email address
     DEFAULT_SUPPORT_EMAIL = nil
 
+    attr_reader :DEFAULT_ADAPTER
     # @private
     attr_accessor *VALID_OPTIONS_KEYS
 
@@ -101,6 +119,14 @@ module Desk
       Thread.current[:adapter] = val
     end
 
+    def auth_method
+      Thread.current[:auth_method] ||= DEFAULT_ADAPTER
+    end
+
+    def auth_method=(val)
+      Thread.current[:auth_method] = val
+    end
+
     def consumer_key
       Thread.current[:consumer_key] ||= DEFAULT_CONSUMER_KEY
     end
@@ -117,6 +143,14 @@ module Desk
       Thread.current[:consumer_secret] = val
     end
 
+    def domain
+      Thread.current[:domain] ||= DEFAULT_DOMAIN
+    end
+
+    def domain=(val)
+      Thread.current[:domain] = val
+    end
+
     def format
       Thread.current[:format] ||= DEFAULT_FORMAT
     end
@@ -208,8 +242,12 @@ module Desk
     # Reset all configuration options to defaults
     def reset
       self.adapter            = DEFAULT_ADAPTER
+      self.auth_method        = DEFAULT_AUTH_METHOD
+      self.basic_auth_username= DEFAULT_BASIC_AUTH_USERNAME
+      self.basic_auth_password= DEFAULT_BASIC_AUTH_PASSWORD
       self.consumer_key       = DEFAULT_CONSUMER_KEY
       self.consumer_secret    = DEFAULT_CONSUMER_SECRET
+      self.domain             = DEFAULT_DOMAIN
       self.format             = DEFAULT_FORMAT
       self.logger             = DEFAULT_LOGGER
       self.max_requests       = DEFAULT_MAX_REQUESTS

data/lib/desk/connection.rb

@@ -19,7 +19,13 @@ module Desk
 
       Faraday.new(options) do |builder|
         builder.use Faraday::Request::MultipartWithFile
-        builder.use Faraday::Request::OAuth, authentication if authenticated?
+        if authenticated?
+          if auth_method == Desk::Authentication::Methods::BASIC
+            builder.use Faraday::Request::BasicAuthentication,basic_auth_username, basic_auth_password
+          else
+            builder.use Faraday::Request::OAuth, authentication
+          end
+        end
         builder.use Faraday::Request::Multipart
         builder.use Faraday::Request::UrlEncoded
         builder.use Faraday::Response::RaiseHttp4xx

data/lib/desk/deash.rb

@@ -17,8 +17,7 @@ module Hashie
   end
 
   class Deash < Mash
-    # Object#type is deprecated
-    Mash.send :undef_method, :type
+    disable_warnings if respond_to?(:disable_warnings)
 
     def count
       if includes_key_chain?("raw._embedded.entries")

data/lib/desk/version.rb

@@ -1,4 +1,4 @@
 module Desk
   # The version of the gem
-  VERSION = '1.0.8'.freeze unless defined?(::Desk::VERSION)
+  VERSION = '1.0.9'.freeze unless defined?(::Desk::VERSION)
 end

data/spec/desk/api_spec.rb

@@ -30,8 +30,12 @@ describe Desk::API do
 
       before do
         @configuration = {
+          :auth_method => Desk::Authentication::Methods::BASIC,
+          :basic_auth_username => 'UN',
+          :basic_auth_password => 'PW',
           :consumer_key => 'CK',
           :consumer_secret => 'CS',
+          :domain => 'example.com',
           :oauth_token => 'OT',
           :oauth_token_secret => 'OS',
           :adapter => :typhoeus,

data/spec/desk/client/customer_spec.rb

@@ -16,7 +16,8 @@ describe Desk::Client do
 
     it_behaves_like "a create endpoint", {
       :first_name => "John",
-      :last_name => "Doe"
+      :last_name => "Doe",
+      :emails => [{:type => "work", :value => "joe.user@example.org"}]
     }
 
     it_behaves_like "an update endpoint", { :first_name => "Johnny" } do

data/spec/desk_spec.rb

@@ -45,6 +45,42 @@ describe Desk do
     end
   end
 
+  describe ".auth_method" do
+    it "should return the default auth method" do
+      Desk.auth_method = Desk::Configuration::DEFAULT_AUTH_METHOD
+    end
+  end
+
+  describe ".auth_method=" do
+    it "should set the auth_method for all auth types" do
+      valid_methods = Desk::Authentication::Methods::ALL*5
+      valid_methods.each do |method|
+        Desk.auth_method = method
+        Desk.auth_method.should == method
+      end
+    end
+  end
+
+  describe ".domain" do
+    it "should return the default domain" do
+      Desk.domain.should == Desk::Configuration::DEFAULT_DOMAIN
+    end
+  end
+
+  describe ".domain=" do
+    before do
+      Desk.domain = "example.org"
+    end
+
+    it "should set the domain" do
+      Desk.domain.should == "example.org"
+    end
+
+    it "should change the endpoint" do
+      Desk.endpoint.should == "https://#{Desk::Configuration::DEFAULT_SUBDOMAIN}.example.org/api/#{Desk::Configuration::DEFAULT_VERSION}/"
+    end
+  end
+
   describe ".subdomain=" do
     before do
       Desk.subdomain = "zencoder"
@@ -55,7 +91,7 @@ describe Desk do
     end
 
     it "should change the endpoint" do
-      Desk.endpoint.should == "https://zencoder.desk.com/api/#{Desk::Configuration::DEFAULT_VERSION}/"
+      Desk.endpoint.should == "https://zencoder.#{Desk::Configuration::DEFAULT_DOMAIN}/api/#{Desk::Configuration::DEFAULT_VERSION}/"
     end
   end
 
@@ -77,7 +113,7 @@ describe Desk do
       Desk.version = "v4"
     end
 
-    it "should set the subdomain" do
+    it "should set the version" do
       Desk.version.should == "v4"
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: desk
 version: !ruby/object:Gem::Version
-  version: 1.0.8
+  version: 1.0.9
 platform: ruby
 authors:
 - Chris Warren
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-03 00:00:00.000000000 Z
+date: 2017-06-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -132,16 +132,22 @@ dependencies:
   name: hashie
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.4.1
+        version: 3.4.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.4.1
+        version: 3.4.2
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
@@ -405,7 +411,8 @@ files:
 - spec/shared_context.rb
 - spec/shared_examples.rb
 homepage: https://github.com/zencoder/desk
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []