nice-reply-client 0.0.2

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZjgwMTAxMjUyYTZmZjU3OTc3YjJkMTYzNjZkNmY3MGFjMDYxZjEyMA==
+  data.tar.gz: !binary |-
+    Njc1NzRkOWJlMzA5Nzc1ZDFjYjM2Y2Y5NGM5ODlmNzY2YTI3Y2NiMQ==
+SHA512:
+  metadata.gz: !binary |-
+    NTMyY2Q1OWMxMGQ1MDJhMjM1ZjNkYjJlMGNhZDg1ZDc5ZmFjNDA0OTQzZjY1
+    NjM5YmU1NTU4NjM1MmExYTY3ZTg1ZWI3MWQwN2ZmMGM3OWM3NDFmNzg2NjRj
+    NDY2Yzg0N2RkZDkwY2NiMDAwOGMzZDM5NDdlNTlmYmI4NjYzNzk=
+  data.tar.gz: !binary |-
+    Zjg1YmMzNzJhZGNhMzlhMWRjZDIxYThmYTY3MGFiZDRkNjE0OGI2YjYxMDk2
+    MDZjOGI5NDg0NzA3MzA4Yjk3ZmQzMDg5ZGRlNTlmMDFjMTUxMGE1MDVkMWYz
+    YzQzOGQ1NTg4MjBmOTRkMjYwYjNhNDYzNzZjYTdjYjQ2ZTRlYmE=

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,201 @@
+Apache License
+Version 2.0, January 2004
+http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+  "License" shall mean the terms and conditions for use, reproduction,
+  and distribution as defined by Sections 1 through 9 of this document.
+
+  "Licensor" shall mean the copyright owner or entity authorized by
+  the copyright owner that is granting the License.
+
+  "Legal Entity" shall mean the union of the acting entity and all
+  other entities that control, are controlled by, or are under common
+  control with that entity. For the purposes of this definition,
+  "control" means (i) the power, direct or indirect, to cause the
+  direction or management of such entity, whether by contract or
+  otherwise, or (ii) ownership of fifty percent (50%) or more of the
+  outstanding shares, or (iii) beneficial ownership of such entity.
+
+  "You" (or "Your") shall mean an individual or Legal Entity
+  exercising permissions granted by this License.
+
+  "Source" form shall mean the preferred form for making modifications,
+  including but not limited to software source code, documentation
+  source, and configuration files.
+
+  "Object" form shall mean any form resulting from mechanical
+  transformation or translation of a Source form, including but
+  not limited to compiled object code, generated documentation,
+  and conversions to other media types.
+
+  "Work" shall mean the work of authorship, whether in Source or
+  Object form, made available under the License, as indicated by a
+  copyright notice that is included in or attached to the work
+  (an example is provided in the Appendix below).
+
+  "Derivative Works" shall mean any work, whether in Source or Object
+  form, that is based on (or derived from) the Work and for which the
+  editorial revisions, annotations, elaborations, or other modifications
+  represent, as a whole, an original work of authorship. For the purposes
+  of this License, Derivative Works shall not include works that remain
+  separable from, or merely link (or bind by name) to the interfaces of,
+  the Work and Derivative Works thereof.
+
+  "Contribution" shall mean any work of authorship, including
+  the original version of the Work and any modifications or additions
+  to that Work or Derivative Works thereof, that is intentionally
+  submitted to Licensor for inclusion in the Work by the copyright owner
+  or by an individual or Legal Entity authorized to submit on behalf of
+  the copyright owner. For the purposes of this definition, "submitted"
+  means any form of electronic, verbal, or written communication sent
+  to the Licensor or its representatives, including but not limited to
+  communication on electronic mailing lists, source code control systems,
+  and issue tracking systems that are managed by, or on behalf of, the
+  Licensor for the purpose of discussing and improving the Work, but
+  excluding communication that is conspicuously marked or otherwise
+  designated in writing by the copyright owner as "Not a Contribution."
+
+  "Contributor" shall mean Licensor and any individual or Legal Entity
+  on behalf of whom a Contribution has been received by Licensor and
+  subsequently incorporated within the Work.
+
+  2. Grant of Copyright License. Subject to the terms and conditions of
+  this License, each Contributor hereby grants to You a perpetual,
+  worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+  copyright license to reproduce, prepare Derivative Works of,
+  publicly display, publicly perform, sublicense, and distribute the
+  Work and such Derivative Works in Source or Object form.
+
+  3. Grant of Patent License. Subject to the terms and conditions of
+  this License, each Contributor hereby grants to You a perpetual,
+  worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+  (except as stated in this section) patent license to make, have made,
+  use, offer to sell, sell, import, and otherwise transfer the Work,
+  where such license applies only to those patent claims licensable
+  by such Contributor that are necessarily infringed by their
+  Contribution(s) alone or by combination of their Contribution(s)
+  with the Work to which such Contribution(s) was submitted. If You
+  institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+  or a Contribution incorporated within the Work constitutes direct
+  or contributory patent infringement, then any patent licenses
+  granted to You under this License for that Work shall terminate
+  as of the date such litigation is filed.
+
+  4. Redistribution. You may reproduce and distribute copies of the
+  Work or Derivative Works thereof in any medium, with or without
+  modifications, and in Source or Object form, provided that You
+  meet the following conditions:
+
+  (a) You must give any other recipients of the Work or
+  Derivative Works a copy of this License; and
+
+  (b) You must cause any modified files to carry prominent notices
+  stating that You changed the files; and
+
+  (c) You must retain, in the Source form of any Derivative Works
+  that You distribute, all copyright, patent, trademark, and
+  attribution notices from the Source form of the Work,
+  excluding those notices that do not pertain to any part of
+  the Derivative Works; and
+
+  (d) If the Work includes a "NOTICE" text file as part of its
+  distribution, then any Derivative Works that You distribute must
+  include a readable copy of the attribution notices contained
+  within such NOTICE file, excluding those notices that do not
+  pertain to any part of the Derivative Works, in at least one
+  of the following places: within a NOTICE text file distributed
+  as part of the Derivative Works; within the Source form or
+  documentation, if provided along with the Derivative Works; or,
+  within a display generated by the Derivative Works, if and
+  wherever such third-party notices normally appear. The contents
+  of the NOTICE file are for informational purposes only and
+  do not modify the License. You may add Your own attribution
+  notices within Derivative Works that You distribute, alongside
+  or as an addendum to the NOTICE text from the Work, provided
+  that such additional attribution notices cannot be construed
+  as modifying the License.
+
+  You may add Your own copyright statement to Your modifications and
+  may provide additional or different license terms and conditions
+  for use, reproduction, or distribution of Your modifications, or
+  for any such Derivative Works as a whole, provided Your use,
+  reproduction, and distribution of the Work otherwise complies with
+  the conditions stated in this License.
+
+  5. Submission of Contributions. Unless You explicitly state otherwise,
+  any Contribution intentionally submitted for inclusion in the Work
+  by You to the Licensor shall be under the terms and conditions of
+  this License, without any additional terms or conditions.
+  Notwithstanding the above, nothing herein shall supersede or modify
+  the terms of any separate license agreement you may have executed
+  with Licensor regarding such Contributions.
+
+  6. Trademarks. This License does not grant permission to use the trade
+  names, trademarks, service marks, or product names of the Licensor,
+  except as required for reasonable and customary use in describing the
+  origin of the Work and reproducing the content of the NOTICE file.
+
+  7. Disclaimer of Warranty. Unless required by applicable law or
+  agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+  implied, including, without limitation, any warranties or conditions
+  of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+  PARTICULAR PURPOSE. You are solely responsible for determining the
+  appropriateness of using or redistributing the Work and assume any
+  risks associated with Your exercise of permissions under this License.
+
+  8. Limitation of Liability. In no event and under no legal theory,
+  whether in tort (including negligence), contract, or otherwise,
+  unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+  liable to You for damages, including any direct, indirect, special,
+  incidental, or consequential damages of any character arising as a
+  result of this License or out of the use or inability to use the
+  Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+  has been advised of the possibility of such damages.
+
+  9. Accepting Warranty or Additional Liability. While redistributing
+  the Work or Derivative Works thereof, You may choose to offer,
+  and charge a fee for, acceptance of support, warranty, indemnity,
+  or other liability obligations and/or rights consistent with this
+  License. However, in accepting such obligations, You may act only
+  on Your own behalf and on Your sole responsibility, not on behalf
+  of any other Contributor, and only if You agree to indemnify,
+  defend, and hold each Contributor harmless for any liability
+  incurred by, or claims asserted against, such Contributor by reason
+  of your accepting any such warranty or additional liability.
+
+  END OF TERMS AND CONDITIONS
+
+  APPENDIX: How to apply the Apache License to your work.
+
+  To apply the Apache License to your work, attach the following
+  boilerplate notice, with the fields enclosed by brackets "[]"
+  replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+  comment syntax for the file format. We also recommend that a
+  file or class name and description of purpose be included on the
+  same "printed page" as the copyright notice for easier
+  identification within third-party archives.
+
+  Copyright [2013] [Blue Box Inc., Nell Shamrell]
+
+  Licensed under the Apache License, Version 2.0 (the "License");
+  you may not use this file except in compliance with the License.
+  You may obtain a copy of the License at
+
+  http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.

data/README.md

@@ -0,0 +1,99 @@
+# Nice Reply Client
+
+This is a simple Ruby wrapper for the [Nice Reply](http://www.nicereply.com/) API.
+
+## Requirements
+
+* A [Nice Reply](http://www.nicereply.com/) Account
+* The account's private API key
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'nice-reply-client'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install nice-reply-client
+
+## Usage
+
+At the top of the class where you will be using Nice Reply Client, make sure to include this line
+<pre>
+  require 'nice_reply_client'
+</pre>
+
+### Creating an instance of Nice Reply Client
+
+<pre>
+  nice_reply_client = NiceReplyClient.new(
+                        api_key: [Your Nice Reply Private API Key]
+                      )
+</pre>
+
+You can now call any method from Nice Reply's API.  You do need to provide the method name in snake_case format.  Please see below for examples.
+
+After each call, the gem will return a hash including the response code and the response body from CDNetworks.
+
+For a complete list of API calls, please see Nice Reply's [API documentation](http://www.nicereply.com/API-example/doc/api-reference.html)
+
+### Examples
+
+Getting your company's average ratings score:
+<pre>
+  nice_reply_client.get_company_average
+  => {:code=>"200", :body=>"{\"companyAverage\":9}"}
+</pre>
+
+Getting your company's user list
+<pre>
+  nice_reply_client.get_user_list
+
+</pre>
+
+Getting an agent's average rating
+<pre>
+  nice_reply_client.get_user_average(
+    username: [Username to get average rating on]
+  )
+</pre>
+
+Getting a agent's average rating from last month
+<pre>
+  nice_reply_client.get_user_average_last_month(
+    username: [agent's username]
+  )
+</pre>
+
+Setting a rating
+<pre>
+  nice_reply_client.set_rating(
+    username: [agent's username],
+    score: 10,
+    from: [person leaving rating],
+    ticket: "A123",
+    comment: "Great service!"
+  )
+</pre>
+
+Updating a rating
+<pre>
+  nice_reply_client.update_rating(
+    id: [id # of rating to update],
+    score: 7,
+    comment: "OK service"
+  )
+</pre>
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Run specs with <pre>rake</pre>
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new
+
+task default: :spec
+task test: :spec

data/lib/nice_reply_client.rb

@@ -0,0 +1,48 @@
+require "nice_reply_client/version"
+require "net/http"
+
+class NiceReplyClient
+  def initialize(credentials={})
+    @api_key = credentials[:api_key]
+  end
+
+  # Thanks to the Gibbon gem https://github.com/amro/gibbon
+  # for the idea to use method_missing and a call method
+  def method_missing(method, *args)
+    call(method,args)
+  end
+
+  private
+
+  def call(method,args)
+    response = http.request(compose_request(method,args[0]))
+    response_hash = { code: response.code, body: response.body }
+  end
+
+  def convert_case(method_name)
+    # Thanks to James Edward Gray II for the regex idea!
+    # https://twitter.com/JEG2/status/358958848649863168
+    method_name.gsub(/_([a-z])/) { |s| $1.upcase }
+  end
+
+  def compose_request(method,options)
+    request = Net::HTTP::Post.new("#{core_url}#{convert_case(method.to_s)}")
+    request.set_form_data(options_with_credentials(options))
+    request
+  end
+
+  def options_with_credentials(options)
+    options = Hash.new if options.nil?
+    options[:apikey] = @api_key
+    options
+  end
+
+  def core_url
+    "http://www.nicereply.com/api/"
+  end
+
+  def http
+    uri = URI.parse(core_url)
+    Net::HTTP.new(uri.host,uri.port)
+  end
+end

data/lib/nice_reply_client/version.rb

@@ -0,0 +1,7 @@
+module Nice
+  module Reply
+    module Client
+      VERSION = "0.0.2"
+    end
+  end
+end

data/nice-reply-client.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'nice_reply_client/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "nice-reply-client"
+  spec.version       = Nice::Reply::Client::VERSION
+  spec.authors       = ["Nell Shamrell"]
+  spec.email         = ["nshamrell@bluebox.net"]
+  spec.description   = %q{Simple wrapper for the Nice Reply API}
+  spec.summary       = %q{Nice Reply API Wrapper}
+  spec.homepage      = "https://github.com/blueboxgroup/nice-reply-client"
+  spec.license       = "Apache"
+
+  spec.files         = `git ls-files`.split($/)
+  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_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "webmock"
+end

data/spec/nice_reply_client_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+
+describe NiceReplyClient do
+  let(:api_key) { "abc123" }
+
+  let :nice_reply_client do
+    NiceReplyClient.new(
+      api_key: api_key
+    )
+  end
+
+  context "calling the API" do
+    let(:url) { "http://www.nicereply.com/api/" }
+    let(:user_id) { "1234" }
+
+    before(:each) do
+      stub_request(
+        :post,
+        "#{url}getUserAverage"
+      ).
+     to_return(:status => 200, :body => "", :headers => {})
+    end
+
+    it "calls the correct api method" do
+      nice_reply_client.get_user_average
+
+      a_request(:post, "#{url}getUserAverage").
+        should have_been_made
+    end
+
+    it "includes the credentials" do
+      nice_reply_client.get_user_average
+
+      a_request(:post, "#{url}getUserAverage").
+        with(body: "apikey=#{api_key}").
+        should have_been_made
+    end
+
+    it "includes options" do
+      nice_reply_client.get_user_average(userid: "#{user_id}")
+
+      a_request(:post, "#{url}getUserAverage").
+        with(body: "userid=#{user_id}&apikey=#{api_key}").
+        should have_been_made
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'nice_reply_client'
+require 'webmock/rspec'

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: nice-reply-client
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Nell Shamrell
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  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: Simple wrapper for the Nice Reply API
+email:
+- nshamrell@bluebox.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/nice_reply_client.rb
+- lib/nice_reply_client/version.rb
+- nice-reply-client.gemspec
+- spec/nice_reply_client_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/blueboxgroup/nice-reply-client
+licenses:
+- Apache
+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.1.11
+signing_key: 
+specification_version: 4
+summary: Nice Reply API Wrapper
+test_files:
+- spec/nice_reply_client_spec.rb
+- spec/spec_helper.rb