surveymonkey_api 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8c3549682e84998718c2eea98d0839b7727b1eab
+  data.tar.gz: '09d30690b5b4a76e1833b6caa6fad9257c364510'
+SHA512:
+  metadata.gz: 03b30f0816910d19494260cdedf7a1f716b8349c43cdcb640254a69bbd18e9481bb8fbe136ca8eca201dade41d45a7e5d17a3ce09b57e502f89f98c7f04bb1ed
+  data.tar.gz: ef651b3962ac6ecbcd4610cc70904cd5d25cbfc8b4e3f82ad6a9f23abfe1dd2ddc1c48d81791c560a3401efb0c04cf3a7fe2245c5c5325482b6f235c449c32fd

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.16.1

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in surveymonkey_api.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,49 @@
+PATH
+  remote: .
+  specs:
+    surveymonkey_api (0.1.0)
+      httparty (~> 0.13)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    byebug (10.0.2)
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    httparty (0.16.2)
+      multi_xml (>= 0.5.2)
+    method_source (0.9.0)
+    multi_xml (0.6.0)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-byebug (3.6.0)
+      byebug (~> 10.0)
+      pry (~> 0.10)
+    rake (10.4.2)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  pry-byebug (~> 3.1)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  surveymonkey_api!
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Carlos
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,61 @@
+# SurveymonkeyApi
+
+Easily interact with the SurveyMonkey API v3. Access matched questions and answers.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'surveymonkey_api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install surveymonkey_api
+
+## Usage
+
+Access a survey:
+```ruby
+Surveymonkey::Survey.new('survey_id')
+```
+
+Access a survey responses:
+```ruby
+survey = _
+survey.responses
+responses = _
+```
+
+Access the first response, and go through each page, question and answer and print the titles:
+```ruby
+responses.first.pages.each do |page|
+  puts page.title
+  page.questions.each do |question|
+    puts question.title
+    question.answers.each do |answer|
+      puts answer.title
+    end
+  end
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/chdezmar/surveymonkey_api.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "surveymonkey_api"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/surveymonkey_api.rb

@@ -0,0 +1,15 @@
+require 'httparty'
+require 'uri'
+require "surveymonkey_api/version"
+require 'surveymonkey_api/client/survey'
+require 'surveymonkey_api/client'
+require 'surveymonkey_api/survey'
+require 'surveymonkey_api/response'
+require 'surveymonkey_api/response/page'
+require 'surveymonkey_api/response/question'
+require 'surveymonkey_api/response/answer'
+require 'pry-byebug'
+
+# Top-level module
+module SurveymonkeyApi
+end

data/lib/surveymonkey_api/client.rb

@@ -0,0 +1,14 @@
+module Surveymonkey
+  # Client
+  class Client
+    include HTTParty
+    include Surveymonkey::Client::Survey
+    base_uri 'https://api.surveymonkey.net/v3'
+    format :json
+
+    def initialize(access_token = nil)
+      @access_token = access_token || ENV['SURVEYMONKEY_API_TOKEN']
+      self.class.default_options.merge!(headers: { 'Authorization' => "bearer #{@access_token}" })
+    end
+  end
+end

data/lib/surveymonkey_api/client/survey.rb

@@ -0,0 +1,37 @@
+module Surveymonkey
+  class Client
+    # Survey endpoints
+    module Survey
+
+      # Return all surveys
+      def surveys(options = {})
+        response = self.class.get('/surveys', { query: options })
+        response.parsed_response
+      end
+
+      # Return survey folders
+      def survey_folders(options = {})
+        response = self.class.get("/survey_folders", { query: options })
+        response.parsed_response
+      end
+
+      # Return survey details (survey structure)
+      def survey_details(survey_id, options = {})
+        response = self.class.get("/surveys/#{survey_id}/details", { query: options })
+        response.parsed_response
+      end
+
+      # Return all survey responses
+      def survey_responses(survey_id, options = {})
+        response = self.class.get("/surveys/#{survey_id}/responses/bulk", { query: options })
+        response.parsed_response
+      end
+
+      # Return survey responses
+      def survey_response(survey_id, response_id, options = {})
+        response = self.class.get("/surveys/#{survey_id}/responses/#{response_id}/details", { query: options })
+        response.parsed_response
+      end
+    end
+  end
+end

data/lib/surveymonkey_api/response.rb

@@ -0,0 +1,34 @@
+module Surveymonkey
+  # Response
+  class Response
+    extend Forwardable
+    attr_reader :survey_id, :id, :survey_structure
+
+    def initialize(survey_id, id)
+      @survey_id = survey_id
+      @id = id
+      @survey_structure = Surveymonkey::Survey.new(survey_id)
+    end
+
+    def raw_details(options = {})
+      client.survey_response(survey_id, id, options)
+    end
+
+    def pages(options = {})
+      @pages ||= client.survey_response(survey_id, id, options)['pages'].each_with_object([]) do |page, arr|
+        if !page['questions'].empty?
+          page_structure = details['pages'].detect{|p| p['id'] == page['id']}
+          arr << Surveymonkey::Response::Page.new(page, page_structure)
+        end
+      end
+    end
+
+    def_delegators :@survey_structure, :details
+
+    private
+
+    def client
+      @client ||= Surveymonkey::Client.new
+    end
+  end
+end

data/lib/surveymonkey_api/response/answer.rb

@@ -0,0 +1,21 @@
+module Surveymonkey
+  # Response Answer
+  class Response::Question::Answer
+    attr_reader :id, :raw_data, :answer_structure
+
+    def initialize(raw_data, answer_structure)
+      @raw_data = raw_data
+      @id = raw_data['choice_id'] || raw_data['other_id']
+      @answer_structure = answer_structure
+    end
+
+    # Match answer title
+    def title
+      @title ||= if raw_data['text']
+        raw_data['text']
+      else
+        answer_structure['choices'].detect {|c| c['id'] == id}['text']
+      end
+    end
+  end
+end

data/lib/surveymonkey_api/response/page.rb

@@ -0,0 +1,24 @@
+module Surveymonkey
+  # Response Page
+  class Response::Page
+    attr_reader :id, :raw_data, :page_structure
+
+    def initialize(raw_data, page_structure)
+      @raw_data = raw_data
+      @id = raw_data['id']
+      @page_structure = page_structure
+    end
+
+    # Match page title
+    def title
+      @title ||= page_structure['title']
+    end
+
+    def questions
+      @questions ||= raw_data['questions'].each_with_object([]) do |question, arr|
+        question_structure = page_structure['questions'].detect{|q| q['id'] == question['id']}
+        arr << Surveymonkey::Response::Question.new(question, question_structure)
+      end
+    end
+  end
+end

data/lib/surveymonkey_api/response/question.rb

@@ -0,0 +1,24 @@
+module Surveymonkey
+  # Response Question
+  class Response::Question
+    attr_reader :id, :raw_data, :question_structure
+
+    def initialize(raw_data, question_structure)
+      @raw_data = raw_data
+      @id = raw_data['id']
+      @question_structure = question_structure
+    end
+
+    # Match response title
+    def title
+      @title ||= question_structure['headings'].first['heading']
+    end
+
+    def answers
+      @answers ||= raw_data['answers'].each_with_object([]) do |answer, arr|
+        answer_structure = question_structure['answers']
+        arr << Surveymonkey::Response::Question::Answer.new(answer, answer_structure)
+      end
+    end
+  end
+end

data/lib/surveymonkey_api/survey.rb

@@ -0,0 +1,30 @@
+module Surveymonkey
+  # Survey
+  class Survey
+    attr_reader :id
+
+    def initialize(id)
+      @id = id
+    end
+
+    def details(options = {})
+      @details ||= client.survey_details(id, options)
+    end
+
+    def raw_responses(options = {})
+      client.survey_responses(id, options)
+    end
+
+    def responses(options = {})
+      @responses ||= client.survey_responses(id, options)['data'].each_with_object([]) do |response, arr|
+        arr << Surveymonkey::Response.new(id, response['id'])
+      end
+    end
+
+    private
+
+    def client
+      @client ||= Surveymonkey::Client.new
+    end
+  end
+end

data/lib/surveymonkey_api/version.rb

@@ -0,0 +1,3 @@
+module SurveymonkeyApi
+  VERSION = "0.2.0"
+end

data/surveymonkey_api.gemspec

@@ -0,0 +1,38 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "surveymonkey_api/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "surveymonkey_api"
+  spec.version       = SurveymonkeyApi::VERSION
+  spec.authors       = ["Carlos"]
+  spec.email         = ["chdezmar@gmail.com"]
+
+  spec.summary       = %q{.}
+  spec.description   = %q{.}
+  spec.homepage      = "https://github.com/chdezmar/surveymonkey_api"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'pry-byebug', "~> 3.1"
+  spec.add_dependency 'httparty', '~> 0.13'
+end

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: surveymonkey_api
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Carlos
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-07-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+description: "."
+email:
+- chdezmar@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/surveymonkey_api.rb
+- lib/surveymonkey_api/client.rb
+- lib/surveymonkey_api/client/survey.rb
+- lib/surveymonkey_api/response.rb
+- lib/surveymonkey_api/response/answer.rb
+- lib/surveymonkey_api/response/page.rb
+- lib/surveymonkey_api/response/question.rb
+- lib/surveymonkey_api/survey.rb
+- lib/surveymonkey_api/survey/page.rb
+- lib/surveymonkey_api/version.rb
+- surveymonkey_api.gemspec
+homepage: https://github.com/chdezmar/surveymonkey_api
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.6.13
+signing_key: 
+specification_version: 4
+summary: "."
+test_files: []