monkey-business 1.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e7f1109a46b4a4a04942c094bde6ce3bbef2683c
+  data.tar.gz: 4bffec75ad3beb6d3dbd16b7e46570535ec89321
+SHA512:
+  metadata.gz: 2142f874d4d0c8248f0ee5f520fa63dae2b3fd1d6c23bf4e09f8d3a01ef8052ee6267a88e3160b7884077307137738014d99abd1920e0742173a8f722a3d7ddc
+  data.tar.gz: 7befab103d4461a98d478a07abc356ab858e6d470f3c0f379f846a3843fcbfddcf6c71d4606308895043dd90cffda3f0a63c6e21282064364a3c97340347554c

data/lib/api/api_resource.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require_relative '../exceptions.rb'
+
+module MonkeyBusiness
+  # Base class for all Surveymonkey API resources
+  class ApiResource
+    attr_accessor :path
+
+    def initialize(api, options = {}, path_prefix = nil)
+      @api = api
+      @id = options.delete(:id)
+      @options = options
+
+      resource_name = self.class
+                          .name
+                          .gsub(/.+::/, '')
+                          .gsub(/(.)([A-Z])/, '\1_\2')
+                          .downcase
+
+      @path = "#{path_prefix}/#{resource_name}"
+      @path += "/#{@id}" if @id
+    end
+
+    def request
+      @api.request(path, @options)
+    end
+
+    private
+
+    def fail_without_id
+      return if @id
+      raise MonkeyBusiness::ApiMethodError.new(
+        <<~MESSAGE
+          ID must be provided for the following method:
+            #{caller_locations(1, 1)[0].label}
+          Expected:
+            #{@path}/:id
+          Received:
+            #{@path}
+        MESSAGE
+      )
+    end
+  end
+end

data/lib/api/collectors.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require_relative 'api_resource.rb'
+require_relative 'responses.rb'
+
+module MonkeyBusiness
+  # Abstraction of the Surveymonkey collectors resource and associated methods
+  class Collectors < ApiResource
+    def responses(options = {})
+      Responses.new(@api, @options.merge(options), @path)
+    end
+  end
+end

data/lib/api/pages.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require_relative 'api_resource.rb'
+require_relative 'questions.rb'
+
+module MonkeyBusiness
+  # Abstraction of the Surveymonkey page resource and associated methods
+  class Pages < ApiResource
+    def questions(options = {})
+      fail_without_id
+      Questions.new(@api, @options.merge(options), @path)
+    end
+  end
+end

data/lib/api/questions.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require_relative 'api_resource.rb'
+
+module MonkeyBusiness
+  # Abstraction of the Surveymonkey question resource  and associated methods
+  class Questions < ApiResource
+  end
+end

data/lib/api/request.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'net/http'
+
+require_relative '../exceptions.rb'
+
+module MonkeyBusiness
+  # Abstraction of an HTTP request sent to the surveymonkey API
+  class HttpRequest
+    def self.request(access_token, uri, options = {})
+      @access_token = access_token
+      @uri = URI(uri)
+
+      @http_method = options[:method] ? options.delete(:method).to_sym : :get
+      @options = options
+
+      raise HttpMethodError, @http_method unless respond_to?(@http_method)
+
+      @http = Net::HTTP.new(@uri.host, @uri.port)
+      @http.use_ssl = true
+
+      send(@http_method)
+    end
+
+    def self.get
+      params = @options.map { |k, v| "#{k}=#{v}" }.join('&')
+
+      request = Net::HTTP::Get.new("#{@uri.request_uri}?#{params}")
+      request['Authorization'] = "bearer #{@access_token}"
+      request['Content-Type'] = 'application/json'
+
+      response = @http.request(request)
+
+      JSON.parse(response.body)
+    end
+
+    def self.post
+      raise NotImplementedError, 'Not Yet Implemented'
+    end
+
+    def self.head
+      request = Net::HTTP::Head.new(@uri.request_uri)
+      request['Authorization'] = "bearer #{@access_token}"
+      request['Content-Type'] = 'application/json'
+
+      @http.request(request).to_hash
+    end
+
+    def self.options
+      request = Net::HTTP::Options.new(@uri.request_uri)
+
+      request['Authorization'] = "bearer #{@access_token}"
+      request['Content-Type'] = 'application/json'
+
+      response = @http.request(request)
+
+      response['Allow'].split(',').map { |x| x.downcase.to_sym }
+    end
+  end
+end

data/lib/api/responses.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require_relative 'api_resource.rb'
+
+module MonkeyBusiness
+  # Abstraction of the Surveymonkey responses resource  and associated methods
+  class Responses < ApiResource
+    def details(options = {})
+      @options.merge!(options)
+      @path += '/details'
+      self
+    end
+
+    def bulk(options = {})
+      @options.merge!(options)
+      @path += '/bulk'
+      self
+    end
+  end
+end

data/lib/api/survey_categories.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require_relative 'api_resource.rb'
+
+module MonkeyBusiness
+  # Abstraction of the Surveymonkey survey_category resource and associated methods
+  class SurveyCategories < ApiResource
+  end
+end

data/lib/api/survey_templates.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require_relative 'api_resource.rb'
+
+module MonkeyBusiness
+  # Abstraction of the Surveymonkey survey_template resource and associated methods
+  class SurveyTemplates < ApiResource
+  end
+end

data/lib/api/surveys.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative 'api_resource.rb'
+require_relative 'responses.rb'
+require_relative 'collectors.rb'
+require_relative 'pages.rb'
+
+module MonkeyBusiness
+  # Abstraction of the Surveymonkey survey resource and associated methods
+  class Surveys < ApiResource
+    def details(options = {})
+      fail_without_id
+      @options.merge!(options)
+      @path += '/details'
+      self
+    end
+
+    def responses(options = {})
+      fail_without_id
+      Responses.new(@api, @options.merge(options), @path)
+    end
+
+    def collectors(options = {})
+      fail_without_id
+      Collectors.new(@api, @options.merge(options), @path)
+    end
+
+    def pages(options = {})
+      fail_without_id
+      Pages.new(@api, @options.merge(options), @path)
+    end
+  end
+end

data/lib/api/users.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require_relative 'api_resource.rb'
+
+module MonkeyBusiness
+  # Abstraction of the Surveymonkey users resource  and associated methods
+  class Users < ApiResource
+    def me(options = {})
+      @options.merge!(options)
+      @path += '/me'
+      self
+    end
+  end
+end

data/lib/exceptions.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+#
+module MonkeyBusiness
+  # Raise this error for malformed API requests
+  class ApiMethodError < ArgumentError; end
+
+  # Raise this error for unsupported HTTP methods
+  class HttpMethodError < ArgumentError
+    def initialize(method_name)
+      super("Unsupported HTTP method: #{method_name}")
+    end
+  end
+end

data/lib/monkey_business.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require_relative 'api/request.rb'
+require_relative 'api/surveys.rb'
+require_relative 'api/survey_categories.rb'
+require_relative 'api/survey_templates.rb'
+require_relative 'api/users.rb'
+
+module MonkeyBusiness
+  API_VERSION = 'v3'
+  BASE_URI = "https://api.surveymonkey.net/#{API_VERSION}"
+
+  # This is the class the end-user should be interacting with.
+  class API
+    def initialize
+      @access_token = ENV['SURVEYMONKEY_ACCESS_TOKEN']
+    end
+
+    def surveys(options = {})
+      Surveys.new(self, options)
+    end
+
+    def survey_categories(options = {})
+      SurveyCategories.new(self, options)
+    end
+
+    def survey_templates(options = {})
+      SurveyTemplates.new(self, options)
+    end
+
+    def users(options = {})
+      Users.new(self, options)
+    end
+
+    def request(resource_path, options = {})
+      HttpRequest.request(
+        @access_token,
+        BASE_URI + resource_path,
+        options
+      )
+    end
+  end
+end

metadata

@@ -0,0 +1,55 @@
+--- !ruby/object:Gem::Specification
+name: monkey-business
+version: !ruby/object:Gem::Version
+  version: 1.0.3
+platform: ruby
+authors:
+- Chris Escue
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-12-05 00:00:00.000000000 Z
+dependencies: []
+description: Send requests to the Surveymonkey API from your Ruby scripts!
+email: chris@escue.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/api/api_resource.rb
+- lib/api/collectors.rb
+- lib/api/pages.rb
+- lib/api/questions.rb
+- lib/api/request.rb
+- lib/api/responses.rb
+- lib/api/survey_categories.rb
+- lib/api/survey_templates.rb
+- lib/api/surveys.rb
+- lib/api/users.rb
+- lib/exceptions.rb
+- lib/monkey_business.rb
+homepage: https://github.com/cescue/monkey-business
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: A simple Ruby client for version 3 of the SurveyMonkey API
+test_files: []