helpshift 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ed3c12f40fea3748aa09775a3542d6bc709f0eaa
-  data.tar.gz: be48a95475001a14feb6afcdbe4608bb5d8034c5
+  metadata.gz: 335563c1c94f9b4a4ceae79192b0ae7c744654c3
+  data.tar.gz: 012516faf88909af0d1fd1eefa617fb1890d9c79
 SHA512:
-  metadata.gz: c44d4ac270044fee6dca3649d792a951de6c52248846bca011f7d8511ace724b46c0bda7507c714ba83ea848d5e9229fe040f2d4dcbaffe8c4ab217e2e55b653
-  data.tar.gz: b2d2058a19742c493228f8828a4266ddc03a3a185f63fc355df384187cd7f0066748142cea230155b5c1fd29f9d73c787af3e1c5dc90f5a9af237ba7b2a6417f
+  metadata.gz: b99913c69d1dea78608e499f8e0a9bd0919bb71d4696af0d55d609fb0bacdbaf9f33745f7009ff7abf92264d3054b72cca5d09c760e090d592810ca666ee1ef1
+  data.tar.gz: 01262ab01a2f0d3d20bf249a09363580f09a719882e18ddc15efae9fef46e1c34895186728656f7c217a4b664f224ee9c96027baffbc8eddd696559123dbc09a

data/README.md

@@ -29,11 +29,23 @@ end
 
 ## Usage
 
-Get issues:
+Get Issues:
 
 ```ruby
-response = Helpshift::Api.new.get('/issues')
-response['issues']
+resp = Helpshift.get('/issues')
+resp['issues']
+```
+
+Update Custom Issue Fields
+
+Configure issue fields in Helpshift admin - https://[customer_domain].helpshift.com/admin/.
+Navigate to Settings > Custom Issue Fields.
+
+Then you can update custom fields for any issue:
+
+```ruby
+resp = Helpshift.put('/issues/4', custom_fields: { my_number_field: { type: 'number', value: 43 } }.to_json)
+resp['updated-data']['custom_fields']) #=> {'my_number_field' => { 'type' => 'number', 'value' => 43 }}
 ```
 
 ## Development

data/lib/helpshift/version.rb

@@ -1,3 +1,3 @@
 module Helpshift
-  VERSION = '0.1.0'.freeze
+  VERSION = '0.1.1'.freeze
 end

data/lib/helpshift.rb

@@ -1,13 +1,43 @@
 require 'helpshift/version'
-require 'helpshift/configuration'
-require 'helpshift/api'
+require 'httparty'
 
 module Helpshift
+  include HTTParty
+
+  BASE_DOMAIN = 'https://api.helpshift.com/v1/'.freeze
+  CONFIGURATION = Struct.new(:customer_domain, :api_key)
+  ConfigurationError = Class.new(StandardError)
+
   def self.config
-    @config ||= Configuration.new
+    @config ||= CONFIGURATION.new
   end
 
   def self.configure
     yield(config)
   end
+
+  def self.base_uri
+    @base_uri ||= if config.customer_domain
+      "#{BASE_DOMAIN}#{config.customer_domain}"
+    else
+      raise ConfigurationError, 'customer_domain is required'
+    end
+  end
+
+  def self.headers
+    @headers ||= if config.api_key
+      require 'base64'
+      { 'Accept' => 'application/json', 'Authorization' => "Basic #{::Base64.encode64(config.api_key).gsub("\n", '')}" }
+    else
+      raise ConfigurationError, 'api_key is required'
+    end
+  end
+
+  def self.get(path, query = {})
+    perform_request Net::HTTP::Get, path, base_uri: base_uri, query: query, headers: headers, format: :json
+  end
+
+  def self.put(path, body)
+    perform_request Net::HTTP::Put, path, base_uri: base_uri, headers: headers, body: body, format: :json
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: helpshift
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Oleksandr Avoyants
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-10-26 00:00:00.000000000 Z
+date: 2017-10-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -114,8 +114,6 @@ files:
 - bin/setup
 - helpshift.gemspec
 - lib/helpshift.rb
-- lib/helpshift/api.rb
-- lib/helpshift/configuration.rb
 - lib/helpshift/version.rb
 homepage: https://github.com/shhavel/helpshift
 licenses:

data/lib/helpshift/api.rb

@@ -1,20 +0,0 @@
-require 'httparty'
-require 'base64'
-
-module Helpshift
-  class Api
-    include ::HTTParty
-    format :json
-
-    def initialize
-      config = ::Helpshift.config
-      raise ::Helpshift::Configuration::Error.new('Not configured') unless config.customer_domain && config.api_key
-      self.class.base_uri "#{config.base_domain}#{config.customer_domain}"
-      @headers = { 'Authorization' => "Basic #{::Base64.encode64(config.api_key).gsub("\n", '')}" }
-    end
-
-    def get(url, query = {})
-      self.class.get(url, query: query, headers: @headers)
-    end
-  end
-end

data/lib/helpshift/configuration.rb

@@ -1,13 +0,0 @@
-module Helpshift
-  class Configuration
-    BASE_DOMAIN = 'https://api.helpshift.com/v1/'.freeze
-    Error = Class.new(StandardError)
-
-    attr_reader :base_domain
-    attr_accessor :customer_domain, :api_key
-
-    def initialize
-      @base_domain = BASE_DOMAIN
-    end
-  end
-end