surveymonkey 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c0c1572387413d53da2a0a44985440a8ea47270f
-  data.tar.gz: 692049f25149f4e8794f099be218fa76fc75b130
+  metadata.gz: 0016ceeb8fa3c8895b7b465a24f4f6e3df95861f
+  data.tar.gz: c3a701a37149d2c21653683e7fa30b21affffb59
 SHA512:
-  metadata.gz: cd15fc54ca2937595c44f09a12c96f2fbf1ed5c14c3842f1a8bf4563267cb7d502e5cc74172628920fb93e68eb672c08c0bf28f2ac82d8ca324b6e6cff6068b2
-  data.tar.gz: 7f05a0f14e09ff41e7c68b57b038141ffffba22ffe30c7832e1fe327c71ec140623692e50dd85e9351930226bc8fb78865b541c778e53d98dedd3a28402ee13a
+  metadata.gz: abc80f434fdcce9004c57845d154f1cce4e9569772d4137a590b558f4c1e9fe45a9a9df656a574f88d4aa80c4dad107943b54f4bb77af73f07045915653f40fa
+  data.tar.gz: e477655cec24b311616023d00215c41a6f1a829c95488631a078847493f9dab58e2a9b602774e04ff74631ea5bad050f942d2583f39387a99f1c32708a6ae035

data/.gitignore

@@ -3,6 +3,7 @@
 /_yardoc/
 /coverage/
 /doc/
+/html/
 /pkg/
 /spec/reports/
 /tmp/

data/Rakefile

@@ -1,6 +1,7 @@
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 require "rubygems/tasks"
+require "rdoc/task"
 
 # Default directory to look in is `/specs`
 # Run with `rake spec`
@@ -14,3 +15,9 @@ task :default => :spec
 Gem::Tasks.new do |tasks|
   tasks.console.command = "pry"
 end
+
+# RDoc tasks
+RDoc::Task.new do |rdoc|
+  rdoc.main = "README.rdoc"
+  rdoc.rdoc_files.include("README.md", "lib/*/*.rb", "lib/*/*/*.rb", "lib/*/*/*/*.rb")
+end

data/lib/surveymonkey.rb

@@ -4,12 +4,21 @@ require "surveymonkey/version"
 require "surveymonkey/logging"
 require "surveymonkey/request"
 
+##
+# Top-level module, holds the user-facing methods
+
 module Surveymonkey
 
   class << self
     # Constants
 
     # Public methods
+
+    ##
+    # Catch-all method; matches SurveyMonkey API method names.  Call like so:
+    #  
+    #  Surveymonkey.get_user_details({'method_params' => {'foo' => 'bar'}})
+
     def method_missing(method_name, *args)
       begin
         $log.debug(sprintf("%s: %s\n", __method__, 'enter'))

data/lib/surveymonkey/api.rb

@@ -1,11 +1,17 @@
 require 'surveymonkey/logging'
 require 'json'
 
+##
+# Object representing the SurveyMonkey API.
+
 class Surveymonkey::API
   autoload :Method, 'surveymonkey/api/method'
 
   # constants
 
+  ##
+  # Hash defining the methods in the SurveyMonkey API.  Current as of 2015-05-05.
+
   Api_methods = {
     'create_flow' => {
       'path' => '/v2/batch/create_flow',
@@ -45,6 +51,9 @@ class Surveymonkey::API
   # public methods
   attr_reader :api_methods
 
+  ##
+  # Look up a SurveyMonkey API method and return its path and associated HTTP method.
+
   def api_method(key, api_methods = self.api_methods)
     begin
       $log.debug(sprintf("%s: api methods: %s\n", __method__, api_methods.inspect))
@@ -69,6 +78,11 @@ class Surveymonkey::API
     end
   end
 
+  ##
+  # SurveyMonkey API method params need to be a JSON-encoded string; this
+  # method passes through a string and tries to turn another data type into
+  # JSON.
+
   def api_method_params(method_params)
     begin
       # TODO validate params against API spec
@@ -85,6 +99,11 @@ class Surveymonkey::API
     end
   end
 
+  ##
+  # Create a new Surveymonkey::API object.  The only parameter is an
+  # api_methods hash (use this if you want to override the definition of the
+  # SurveyMonkey API, I guess?)
+
   def initialize
     begin
       @api_methods = Api_methods

data/lib/surveymonkey/api/method.rb

@@ -1,8 +1,15 @@
 require 'surveymonkey/logging'
 
+##
+# Object representing a SurveyMonkey API method.
+
 class Surveymonkey::API::Method
   attr_reader :path, :http_method
 
+  ##
+  # Create a new method.  Does some input validation to make sure the
+  # associated HTTP method is valid.
+
   def initialize(path, http_method = 'post')
     begin
       $log.debug(sprintf("%s: enter", __method__))

data/lib/surveymonkey/client.rb

@@ -3,6 +3,9 @@ require "json"
 
 require "surveymonkey/logging"
 
+##
+# Class encapsulating the HTTParty client used to communicate with the SurveyMonkey API.
+
 class Surveymonkey::Client
   include HTTParty
 
@@ -13,6 +16,12 @@ class Surveymonkey::Client
   # public methods
   attr_reader :baseuri, :api_key, :access_token
 
+  ##
+  # Create a new Surveymonkey::Client object.  Requires the following parameters:
+  # * baseuri
+  # * access_token
+  # * api_key
+
   def initialize(baseuri, access_token, api_key)
     begin
       @baseuri      = baseuri
@@ -37,7 +46,7 @@ class Surveymonkey::Client
   # private methods
   private
 
-  def _http_headers(token)
+  def _http_headers(token) #:nodoc:
     begin
       $log.debug(sprintf("%s: constructing http headers with token '%s'\n", __method__, token))
       http_headers = {

data/lib/surveymonkey/logging.rb

@@ -1,3 +1,13 @@
+##
+# Implement logging for Surveymonkey via the Logging library.
+#
+# Logging configuration happens at runtime and is drawn from the
+# **SURVEYMONKEY_LOGLEVEL** environment variable.  Set this variable to one of
+# the standard syslog levels (debug, info, warning, error, fatal) to enable
+# more or less logging.  At present Surveymonkey logs a lot of debug messages,
+# and other than that just emits errors and fatals if it encounters problems.
+# The default loglevel is error.
+
 module Surveymonkey::Logging
   # initialize logging
   if ENV.member?('SURVEYMONKEY_LOGLEVEL')

data/lib/surveymonkey/request.rb

@@ -2,6 +2,9 @@ require 'surveymonkey/logging'
 require 'surveymonkey/api'
 require 'surveymonkey/client'
 
+##
+# Object representing a request to the SurveyMonkey API.  Parameters should all be populated automatically.
+
 class Surveymonkey::Request
 
   begin
@@ -13,6 +16,13 @@ class Surveymonkey::Request
     Baseuri = 'https://api.surveymonkey.net'
 
     # public methods
+
+    ##
+    # Send the HTTP request to the SurveyMonkey API and parse the response.
+    # This is an opportunity to override defaults, _e.g._ if you want to use
+    # different credentials for a specific request, or if you're sending the
+    # same request repeatedly with different parameters.
+
     def execute(method_params = self.method_params, api_method = self.api_method, api_key = self.api_key, access_token = self.access_token)
       begin
         $log.debug(sprintf("%s: enter\n", __method__))
@@ -44,6 +54,14 @@ class Surveymonkey::Request
       end
     end
 
+    ##
+    # Create a new Surveymonkey::Request object.  Takes a string representing the API method name and a hash of parameters; the relevant parameters are the following:
+    #
+    # * baseuri
+    # * method_params
+    # * access_token
+    # * api_key
+
     def initialize(api_method, *args)
       begin
         $log.debug(sprintf("%s: enter\n", __method__))
@@ -75,7 +93,7 @@ class Surveymonkey::Request
     # private methods
     private
 
-    def _client
+    def _client #:nodoc:
       begin
         @client = Surveymonkey::Client.new()
       rescue StandardError => e
@@ -85,7 +103,7 @@ class Surveymonkey::Request
       end
     end
 
-    def _api
+    def _api #:nodoc:
       begin
         @api = Surveymonkey::API.new()
       rescue StandardError => e
@@ -95,7 +113,7 @@ class Surveymonkey::Request
       end
     end
 
-    def _http_headers(token)
+    def _http_headers(token) #:nodoc:
       begin
         $log.debug(sprintf("%s: constructing http headers with token '%s'\n", __method__, token))
         http_headers = {
@@ -111,7 +129,7 @@ class Surveymonkey::Request
       end
     end
 
-    def _from_env(key)
+    def _from_env(key) #:nodoc:
       begin
         $log.debug(sprintf("%s: fetching '%s' from environment\n", __method__, key))
         value = ENV.fetch(key)
@@ -126,7 +144,7 @@ class Surveymonkey::Request
       end
     end
 
-    def _request_uri(path, api_key)
+    def _request_uri(path, api_key) #:nodoc:
       begin
         $log.debug(sprintf("%s: generating request uri fragment from '%s' and '%s'\n", __method__, path, api_key))
         request_uri = sprintf("%s?api_key=%s", path, api_key)

data/lib/surveymonkey/version.rb

@@ -1,3 +1,6 @@
+##
+# Specify the version of the surveymonkey gem.
+
 module Surveymonkey
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

data/surveymonkey.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
 
   spec.summary       = %q{Client for SurveyMonkey REST API}
   spec.description   = %q{Interact with SurveyMonkey's REST API.  Requires an API token.}
-  spec.homepage      = "http://developer.surveymonkey.com/"
+  spec.homepage      = "https://github.com/hakamadare/rubygem-surveymonkey/"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
@@ -24,6 +24,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", ">= 1.7"
   spec.add_development_dependency "pry", "~> 0.10"
   spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rdoc", "~> 4"
   spec.add_development_dependency "rspec", "~> 2.4"
   spec.add_development_dependency "rubygems-tasks", "~> 0.2"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: surveymonkey
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Steve Huff
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-05-04 00:00:00.000000000 Z
+date: 2015-05-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,20 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -144,12 +158,11 @@ files:
 - lib/surveymonkey/api.rb
 - lib/surveymonkey/api/method.rb
 - lib/surveymonkey/client.rb
-- lib/surveymonkey/config.rb
 - lib/surveymonkey/logging.rb
 - lib/surveymonkey/request.rb
 - lib/surveymonkey/version.rb
 - surveymonkey.gemspec
-homepage: http://developer.surveymonkey.com/
+homepage: https://github.com/hakamadare/rubygem-surveymonkey/
 licenses:
 - MIT
 metadata: {}

data/lib/surveymonkey/config.rb

@@ -1,10 +0,0 @@
-class Surveymonkey::Config
-  attr_accessor :apiversion, :baseurl
-
-  def initialize(baseurl = 'https://api.surveymonkey.net', apiversion = '2')
-    @baseurl = baseurl
-    @apiversion = apiversion
-
-    @apiurl = "#{baseurl}/v#{apiversion}"
-  end
-end