surveymonkey 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bcc8b046283c6458cefb32ba467347378219a96b
-  data.tar.gz: 5c193620b02c368f19bf86c2030d1fc8da6e03bc
+  metadata.gz: c0c1572387413d53da2a0a44985440a8ea47270f
+  data.tar.gz: 692049f25149f4e8794f099be218fa76fc75b130
 SHA512:
-  metadata.gz: da13f7310d7db4eb8eefcd2c4c37dd89a8afd7aeaf67b94e1c9b45cdffe3a7894db6322bd2b33d334b47b6a467fc2973fd364c962c3f2ecc35fd4c4c9c6b0fe9
-  data.tar.gz: 2715e724f7aaaffbae8b85731b2d2a300df2af2329d2b6dac58f0994865cb913a84498d6f1654f93b91330f9ec7ae6e1d33a90a1b8ff6a15bb13e3001fb5011e
+  metadata.gz: cd15fc54ca2937595c44f09a12c96f2fbf1ed5c14c3842f1a8bf4563267cb7d502e5cc74172628920fb93e68eb672c08c0bf28f2ac82d8ca324b6e6cff6068b2
+  data.tar.gz: 7f05a0f14e09ff41e7c68b57b038141ffffba22ffe30c7832e1fe327c71ec140623692e50dd85e9351930226bc8fb78865b541c778e53d98dedd3a28402ee13a

data/README.md

@@ -1,4 +1,4 @@
-# Surveymonkey [![Build Status](https://travis-ci.org/hakamadare/rubygem-surveymonkey.svg?branch=master)](https://travis-ci.org/hakamadare/rubygem-surveymonkey)
+# Surveymonkey [![Build Status](https://travis-ci.org/hakamadare/rubygem-surveymonkey.svg?branch=master)](https://travis-ci.org/hakamadare/rubygem-surveymonkey) [![Gem Version](https://badge.fury.io/rb/surveymonkey.svg)](http://badge.fury.io/rb/surveymonkey)
 
 This is a client for the SurveyMonkey [RESTful API](http://developer.surveymonkey.com).
 
@@ -50,9 +50,9 @@ The SurveyMonkey API methods are documented [here](https://developer.surveymonke
     {"username"=>"XXXXXX", "is_paid_account"=>true, "is_enterprise_user"=>false}}}
 ```
 
-To pass parameters to an API method, pass a hash like so:
+To pass parameters to an API method, pass a hash as the `method_params` parameter like so:
 ```ruby
-[2] pry(main)> Surveymonkey.get_survey_list({"page_size" => 5, "order_asc" => true})
+[2] pry(main)> Surveymonkey.get_survey_list('method_params' => {"page_size" => 5, "order_asc" => true})
 => {"status"=>0,
  "data"=>
   {"surveys"=>

data/lib/surveymonkey/api/method.rb

@@ -0,0 +1,30 @@
+require 'surveymonkey/logging'
+
+class Surveymonkey::API::Method
+  attr_reader :path, :http_method
+
+  def initialize(path, http_method = 'post')
+    begin
+      $log.debug(sprintf("%s: enter", __method__))
+
+      # FIXME validate the path
+      @path = path
+
+      # validate the method
+      $log.debug(sprintf("%s:http_method: '%s'\n", __method__, http_method))
+      the_method = http_method.to_s.downcase
+      $log.debug(sprintf("%s:the_method: '%s'\n", __method__, the_method))
+
+      if the_method =~ /^(get|post|patch|put|delete|move|copy|head|options)$/
+        @http_method = the_method
+        $log.debug(sprintf("%s: method: %s", __method__, the_method))
+      else
+        raise StandardError, "'#{the_method}' is not a valid HTTP method", caller
+      end
+
+    rescue StandardError => e
+      $log.error(sprintf("%s: unable to initialize API method: %s\n", __method__, e.message))
+      raise
+    end
+  end
+end

data/lib/surveymonkey/api.rb

@@ -0,0 +1,96 @@
+require 'surveymonkey/logging'
+require 'json'
+
+class Surveymonkey::API
+  autoload :Method, 'surveymonkey/api/method'
+
+  # constants
+
+  Api_methods = {
+    'create_flow' => {
+      'path' => '/v2/batch/create_flow',
+    },
+    'send_flow' => {
+      'path' => '/v2/batch/send_flow',
+    },
+    'create_collector' => {
+      'path' => '/v2/collectors/create_collector',
+    },
+    'get_survey_list' => {
+      'path' => '/v2/surveys/get_survey_list',
+    },
+    'get_survey_details' => {
+      'path' => '/v2/surveys/get_survey_details',
+    },
+    'get_collector_list' => {
+      'path' => '/v2/surveys/get_collector_list',
+    },
+    'get_respondent_list' => {
+      'path' => '/v2/surveys/get_respondent_list',
+    },
+    'get_responses' => {
+      'path' => '/v2/surveys/get_responses',
+    },
+    'get_response_counts' => {
+      'path' => '/v2/surveys/get_response_counts',
+    },
+    'get_template_list' => {
+      'path' => '/v2/templates/get_template_list',
+    },
+    'get_user_details' => {
+      'path' => '/v2/user/get_user_details',
+    },
+  }
+
+  # public methods
+  attr_reader :api_methods
+
+  def api_method(key, api_methods = self.api_methods)
+    begin
+      $log.debug(sprintf("%s: api methods: %s\n", __method__, api_methods.inspect))
+      $log.debug(sprintf("%s: fetching '%s' from API methods\n", __method__, key))
+      value = api_methods.fetch(key)
+      $log.debug(sprintf("%s: retrieved '%s'\n", __method__, value.inspect))
+
+      path = value['path']
+      $log.debug(sprintf("%s: path '%s'\n", __method__, path))
+      method = (value['method'] || 'post')
+      $log.debug(sprintf("%s: method '%s'\n", __method__, method))
+
+      # return
+      Surveymonkey::API::Method.new(path, method)
+
+    rescue KeyError => e
+      $log.error(sprintf("%s: '%s' not found in api methods\n", __method__, key))
+      raise e
+    rescue StandardError => e
+      $log.error(sprintf("%s: %s\n", __method__, e.message))
+      raise
+    end
+  end
+
+  def api_method_params(method_params)
+    begin
+      # TODO validate params against API spec
+      $log.debug(sprintf("%s: parsing api method params from '%s'\n", __method__, method_params))
+      the_params = (method_params.kind_of?(String) ? method_params : JSON.generate(method_params || {}))
+      $log.debug(sprintf("%s: parsed method params '%s'\n", __method__, the_params))
+
+      # return
+      the_params
+
+    rescue StandardError => e
+      $log.error(sprintf("%s: %s\n", __method__, e.message))
+      raise
+    end
+  end
+
+  def initialize
+    begin
+      @api_methods = Api_methods
+    rescue StandardError => e
+      $log.error(sprintf("%s: %s\n", __method__, e.message))
+      raise
+    end
+  end
+end

data/lib/surveymonkey/client.rb

@@ -9,91 +9,15 @@ class Surveymonkey::Client
   $log.debug("Defined Surveymonkey::Client.")
 
   # constants
-  Baseuri = 'https://api.surveymonkey.net'
-
-  Api_methods = {
-    'create_flow' => {
-      'path'   => '/v2/batch/create_flow',
-    },
-    'send_flow' => {
-      'path'   => '/v2/batch/send_flow',
-    },
-    'create_collector' => {
-      'path'   => '/v2/collectors/create_collector',
-    },
-    'get_survey_list' => {
-      'path'   => '/v2/surveys/get_survey_list',
-    },
-    'get_survey_details' => {
-      'path'   => '/v2/surveys/get_survey_details',
-    },
-    'get_collector_list' => {
-      'path'   => '/v2/surveys/get_collector_list',
-    },
-    'get_respondent_list' => {
-      'path'   => '/v2/surveys/get_respondent_list',
-    },
-    'get_responses' => {
-      'path'   => '/v2/surveys/get_responses',
-    },
-    'get_response_counts' => {
-      'path'   => '/v2/surveys/get_response_counts',
-    },
-    'get_template_list' => {
-      'path'   => '/v2/templates/get_template_list',
-    },
-    'get_user_details' => {
-      'path'   => '/v2/user/get_user_details',
-    },
-  }
 
   # public methods
-  attr_reader :baseuri, :api_key
-  attr_accessor :access_token
-
-  def api_call(api_method, method_params = {}, api_key = self.api_key, access_token = self.access_token)
-    begin
-      $log.debug(sprintf("%s: calling '%s'\n", __method__, api_method))
-
-      the_api_method = _api_method(api_method)
-
-      body        = _api_method_params(method_params)
-
-      path        = the_api_method.fetch('path')
-
-      http_method = the_api_method.fetch('method', 'post')
-
-      $log.debug(sprintf("%s: %s '%s' '%s'\n", __method__, http_method, path, body))
-
-      http_headers = _http_headers(access_token)
-      $log.debug(sprintf("%s: http_headers: '%s'\n", __method__, http_headers.inspect))
-
-      request_uri = _request_uri(path, api_key)
-
-      $log.debug(sprintf("%s: ready to make request for '%s'\n", __method__, api_method))
-      response = self.class.send(http_method.to_sym, request_uri, body: body, headers: http_headers)
-
-      $log.debug(sprintf("%s: response class %s\n", __method__, response.class))
-      $log.debug(sprintf("%s: response code %i\n", __method__, response.code))
-      $log.debug(sprintf("%s: response headers '%s'\n", __method__, response.headers.inspect))
+  attr_reader :baseuri, :api_key, :access_token
 
-      response.parsed_response
-
-    rescue KeyError => e
-      $log.error(sprintf("%s: no such method '%s': %s\n", __method__, http_method, e.message))
-      raise e
-    rescue Exception => e
-      $log.error(sprintf("%s: %s\n", __method__, e.message))
-      raise
-    end
-  end
-
-  def initialize(*args)
+  def initialize(baseuri, access_token, api_key)
     begin
-      param_hash = args.shift || {}
-      @baseuri      = param_hash.fetch('baseuri', Baseuri)
-      @access_token = param_hash.fetch('access_token', _from_env('SURVEYMONKEY_ACCESSTOKEN'))
-      @api_key      = param_hash.fetch('api_key', _from_env('SURVEYMONKEY_APIKEY'))
+      @baseuri      = baseuri
+      @access_token = access_token
+      @api_key      = api_key
 
       self.class.logger $log, :debug
 
@@ -101,12 +25,10 @@ class Surveymonkey::Client
       self.class.base_uri @baseuri
 
       $log.debug(sprintf("%s: setting headers'\n", __method__))
-      the_headers = {
-        "Content-Type"  => "application/json",
-        "Authorization" => sprintf("bearer %s", @access_token),
-      }
-      self.class.headers the_headers
-    rescue Exception => e
+      http_headers = _http_headers(@access_token)
+      self.class.headers http_headers
+
+    rescue StandardError => e
       $log.error(sprintf("%s: %s\n", __method__, e.message))
       raise
     end
@@ -115,22 +37,6 @@ class Surveymonkey::Client
   # private methods
   private
 
-  def _api_method(key, api_methods = Api_methods)
-    begin
-      $log.debug(sprintf("%s: fetching '%s' from api methods\n", __method__, key))
-      value = api_methods.fetch(key)
-      $log.debug(sprintf("%s: retrieved '%s'\n", __method__, value.inspect))
-      value
-
-    rescue KeyError => e
-      $log.error(sprintf("%s: '%s' not found in api methods\n", __method__, key))
-      raise e
-    rescue Exception => e
-      $log.error(sprintf("%s: %s\n", __method__, e.message))
-      raise
-    end
-  end
-
   def _http_headers(token)
     begin
       $log.debug(sprintf("%s: constructing http headers with token '%s'\n", __method__, token))
@@ -141,49 +47,7 @@ class Surveymonkey::Client
       $log.debug(sprintf("%s: http headers: '%s'\n", __method__, http_headers))
       http_headers
 
-    rescue Exception => e
-      $log.error(sprintf("%s: %s\n", __method__, e.message))
-      raise
-    end
-  end
-
-  def _api_method_params(method_params)
-    begin
-      # TODO validate params against API spec
-      $log.debug(sprintf("%s: parsing api method params from '%s'\n", __method__, method_params))
-      the_params = JSON.generate(method_params || {}).to_s
-      $log.debug(sprintf("%s: parsed method params '%s'\n", __method__, the_params))
-      the_params
-
-    rescue Exception => e
-      $log.error(sprintf("%s: %s\n", __method__, e.message))
-      raise
-    end
-  end
-
-  def _request_uri(path, api_key)
-    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)
-      $log.debug(sprintf("%s: generated '%s'\n", __method__, request_uri))
-      request_uri
-
-    rescue Exception => e
-      $log.error(sprintf("%s: %s\n", __method__, e.message))
-      raise
-    end
-  end
-
-  def _from_env(key)
-    begin
-      $log.debug(sprintf("%s: fetching '%s' from environment\n", __method__, key))
-      value = ENV.fetch(key)
-      $log.debug(sprintf("%s: retrieved '%s'\n", __method__, value))
-      value
-
-    rescue KeyError => e
-      $log.info(sprintf("%s: '%s' not found in environment\n", __method__, key))
-    rescue Exception => e
+    rescue StandardError => e
       $log.error(sprintf("%s: %s\n", __method__, e.message))
       raise
     end

data/lib/surveymonkey/request.rb

@@ -0,0 +1,142 @@
+require 'surveymonkey/logging'
+require 'surveymonkey/api'
+require 'surveymonkey/client'
+
+class Surveymonkey::Request
+
+  begin
+    attr_reader :api, :api_method, :client, :path, :api_key, :baseuri
+    attr_accessor :access_token, :method_params
+
+    # constants
+
+    Baseuri = 'https://api.surveymonkey.net'
+
+    # public methods
+    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__))
+
+        self.method_params=(self.api.api_method_params(method_params))
+        method_params = self.method_params
+        $log.debug(sprintf("%s: method_params: %s\n", __method__, method_params))
+
+        path = api_method.path
+        $log.debug(sprintf("%s: path: %s\n", __method__, path))
+
+        http_method = api_method.http_method
+        $log.debug(sprintf("%s: http_method: %s\n", __method__, http_method))
+
+        request_uri = _request_uri(path, api_key)
+        $log.debug(sprintf("%s: ready to make request for '%s'\n", __method__, api_method))
+
+        response = self.client.class.send(http_method.to_sym, request_uri, body: self.method_params)
+
+        $log.debug(sprintf("%s: response class %s\n", __method__, response.class))
+        $log.debug(sprintf("%s: response code %i\n", __method__, response.code))
+        $log.debug(sprintf("%s: response headers '%s'\n", __method__, response.headers.inspect))
+
+        response.parsed_response
+
+      rescue StandardError => e
+        $log.error(sprintf("%s: unable to execute API request: %s\n", __method__, e.message))
+        raise
+      end
+    end
+
+    def initialize(api_method, *args)
+      begin
+        $log.debug(sprintf("%s: enter\n", __method__))
+        $log.debug(sprintf("%s: api_method: %s\n", __method__, api_method))
+        $log.debug(sprintf("%s: args: %s\n", __method__, args))
+
+        api = Surveymonkey::API.new
+        @api_method = api.api_method(api_method)
+
+        # extract optional params
+        param_hash = Hash.try_convert(args.shift) || {}
+        @baseuri       = param_hash.fetch('baseuri', Baseuri)
+        @method_params = api.api_method_params(param_hash.fetch('method_params', {}))
+        @access_token  = param_hash.fetch('access_token', _from_env('SURVEYMONKEY_ACCESSTOKEN'))
+        @api_key       = param_hash.fetch('api_key', _from_env('SURVEYMONKEY_APIKEY'))
+
+        # configure the client
+        @client = Surveymonkey::Client.new(baseuri = @baseuri, access_token = @access_token, api_key = @api_key)
+
+        # configure the API
+        @api = Surveymonkey::API.new
+
+      rescue StandardError => e
+        $log.error(sprintf("%s: unable to initialize API request: %s\n", __method__, e.message))
+        raise
+      end
+    end
+
+    # private methods
+    private
+
+    def _client
+      begin
+        @client = Surveymonkey::Client.new()
+      rescue StandardError => e
+        $log.fatal(sprintf("%s: %s\n", "Unable to initialize REST client", e.message))
+        $log.debug(sprintf("%s: %s\n", __method__, e.message))
+        raise
+      end
+    end
+
+    def _api
+      begin
+        @api = Surveymonkey::API.new()
+      rescue StandardError => e
+        $log.fatal(sprintf("%s: %s\n", "Unable to initialize SurveyMonkey API", e.message))
+        $log.debug(sprintf("%s: %s\n", __method__, e.message))
+        raise
+      end
+    end
+
+    def _http_headers(token)
+      begin
+        $log.debug(sprintf("%s: constructing http headers with token '%s'\n", __method__, token))
+        http_headers = {
+          "Content-Type" => "application/json",
+          "Authorization" => sprintf("bearer %s", token),
+        }
+        $log.debug(sprintf("%s: http headers: '%s'\n", __method__, http_headers))
+        http_headers
+
+      rescue Exception => e
+        $log.error(sprintf("%s: %s\n", __method__, e.message))
+        raise
+      end
+    end
+
+    def _from_env(key)
+      begin
+        $log.debug(sprintf("%s: fetching '%s' from environment\n", __method__, key))
+        value = ENV.fetch(key)
+        $log.debug(sprintf("%s: retrieved '%s'\n", __method__, value))
+        value
+
+      rescue KeyError => e
+        $log.info(sprintf("%s: '%s' not found in environment\n", __method__, key))
+      rescue Exception => e
+        $log.error(sprintf("%s: %s\n", __method__, e.message))
+        raise
+      end
+    end
+
+    def _request_uri(path, api_key)
+      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)
+        $log.debug(sprintf("%s: generated '%s'\n", __method__, request_uri))
+        request_uri
+
+      rescue StandardError => e
+        $log.error(sprintf("%s: %s\n", __method__, e.message))
+        raise
+      end
+    end
+  end
+end

data/lib/surveymonkey/version.rb

@@ -1,3 +1,3 @@
 module Surveymonkey
-  VERSION = "0.1.3"
+  VERSION = "0.2.0"
 end

data/lib/surveymonkey.rb

@@ -2,9 +2,9 @@ require "logging"
 
 require "surveymonkey/version"
 require "surveymonkey/logging"
+require "surveymonkey/request"
 
 module Surveymonkey
-  autoload :Client, "surveymonkey/client"
 
   class << self
     # Constants
@@ -15,17 +15,19 @@ module Surveymonkey
         $log.debug(sprintf("%s: %s\n", __method__, 'enter'))
 
         method_params = Hash(Array(args).shift) || {}
+        $log.debug(sprintf("%s: method_params: %s\n", __method__, method_params.inspect))
 
-        response = _client.send(:api_call, method_name.to_s, method_params)
+        request = Surveymonkey::Request.new(method_name.to_s, method_params)
+        response = request.execute
         response
 
       rescue TypeError => e
-        $log.fatal(sprintf("%s: method parameters must be a hash\n"))
+        $log.fatal(sprintf("%s: method parameters must be a hash\n", __method__))
         exit 1
       rescue KeyError => e
-        $log.fatal(sprintf("%s: method '%s' not implemented\n"))
+        $log.fatal(sprintf("%s: method '%s' not implemented\n", __method__, method_name.to_s))
         exit 1
-      rescue Exception => e
+      rescue StandardError => e
         $log.error(sprintf("%s: %s\n", __method__, e.message))
         raise
       end
@@ -34,15 +36,5 @@ module Surveymonkey
     # Private methods
     private
 
-    def _client
-      begin
-        @client = Surveymonkey::Client.new()
-      rescue Exception => e
-        $log.fatal(sprintf("%s: %s\n", "Unable to initialize REST client", e.message))
-        $log.debug(sprintf("%s: %s\n", __method__, e.message))
-        raise
-      end
-    end
   end
-
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: surveymonkey
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Steve Huff
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-05-01 00:00:00.000000000 Z
+date: 2015-05-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -141,9 +141,12 @@ files:
 - bin/console
 - bin/setup
 - lib/surveymonkey.rb
+- 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/