survey_monkey_api 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c1cf445d07ab81c4b2d0a8b2e6a7d46bc3032cfa
-  data.tar.gz: 0e7abb29aab6507e2e033291b8043e4023f88a08
+  metadata.gz: cc47049a0d0d095e58926273abaf25f5ea4974e6
+  data.tar.gz: 23bffa808dfa822b46f43e16281fecf68f1422cd
 SHA512:
-  metadata.gz: c56fa2a1e3dd88c364a99473067d3f9a6dc50c15880556afb80edeefd62c7d82215d95d42d1bbaeddcd8812d44a84a6b77dcc5f3430ffd9614afbe6290007fbd
-  data.tar.gz: 2aee5bddb79281c3464249b9836e0d027259c810d8f1c66ac3a8bff447de9ef886e55a8b044c9879e3ba924891d9c66f9d3ef28ed4e4a9561d26f7285fb9d51d
+  metadata.gz: a02e2402277fb4fa14d2256d5fb9e77fe8dd6c38bb9248d325fd1963c800ae8099b55a5e7134617558e8b5cf1767975b7c9c804b8acfb2791d68ffa218158568
+  data.tar.gz: 76950b51efbd75e959d7e9fab8905cc9d80f5eabad8ce408698999e85f2d9a8ff317d1a9f8a6c4d42ed1285876bcdb8fead65a7e345e082edf88178e244b4818

data/README.md

@@ -0,0 +1,91 @@
+# SurveyMonkeyApi
+
+Actions with surveys in SurveyMonkey system.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'survey_monkey_api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install survey_monkey_api
+
+## Usage
+
+### Create SurveyMonkeyApi object
+
+```ruby
+  require 'survey_monkey_api'
+  client = SurveyMonkeyApi::Client.new
+```
+
+### User information
+
+Request for getting user's information is #me.
+
+```ruby
+  client.me
+```
+
+#### Responces
+
+```ruby
+  {
+    "username"=>"SomeUsername",
+    "scopes"=>{"available"=>["users_read", "surveys_read", "collectors_read", "collectors_write", "contacts_read", "contacts_write", "surveys_write", "responses_read", "responses_read_detail", "responses_write", "groups_read", "webhooks_read", "webhooks_write", "library_read"], "granted"=>["collectors_read", "contacts_write", "contacts_read", "surveys_write", "surveys_read", "collectors_write", "users_read"]},
+    "first_name"=>nil,
+    "last_name"=>nil,
+    "account_type"=>"premier_annual",
+    "language"=>"da",
+    "email_verified"=>false,
+    "email"=>"johndoe@gmail.com",
+    "href"=>"https://api.surveymonkey.net/v3/users/me",
+    "date_last_login"=>"2017-12-21T13:44:01.470000+00:00",
+    "sso_connections"=>[],
+    "date_created"=>"2016-05-11T09:48:00+00:00",
+    "id"=>"00000001"
+  }
+```
+
+### Surveys
+
+Request for getting list of surveys is #surveys.
+
+```ruby
+  client.surveys
+```
+
+#### Responces
+
+```ruby
+  {
+    "per_page"=>50,
+    "total"=>99,
+    "data"=>[
+      {"href"=>"https://api.surveymonkey.net/v3/surveys/000000001", "nickname"=>"", "id"=>"000000001", "title"=>"First"},
+      {"href"=>"https://api.surveymonkey.net/v3/surveys/000000002", "nickname"=>"", "id"=>"000000002", "title"=>"Second"}
+    ],
+    "page"=>1,
+    "links"=>{
+      "self"=>"https://api.surveymonkey.net/v3/surveys?page=1&per_page=50",
+      "last"=>"https://api.surveymonkey.net/v3/surveys?page=2&per_page=50",
+      "next"=>"https://api.surveymonkey.net/v3/surveys?page=2&per_page=50"
+    }
+  }
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/kortirso/surveymonkey.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/lib/surveymonkey/client/surveys.rb

@@ -0,0 +1,14 @@
+module SurveyMonkeyApi
+    class Client
+        # API endpoints for surveys resources
+        module Surveys
+            # Returns list of surveys as array in ['data'] field
+            # Each survey looks like
+            # {"href"=>"https://api.surveymonkey.net/v3/surveys/120053599", "nickname"=>"", "id"=>"120053599", "title"=>"Nyt"}
+            def surveys(options = {})
+                response = self.class.get('/v3/surveys', query: options)
+                response.parsed_response
+            end
+        end
+    end
+end

data/lib/surveymonkey/client/users.rb

@@ -0,0 +1,12 @@
+module SurveyMonkeyApi
+    class Client
+        # API endpoints for users resources
+        module Users
+            # Returns current user's information
+            def me(options = {})
+                response = self.class.get('/v3/users/me', query: options)
+                response.parsed_response
+            end
+        end
+    end
+end

data/lib/surveymonkey/client.rb

@@ -0,0 +1,20 @@
+require 'httparty'
+require_relative 'client/users'
+require_relative 'client/surveys'
+
+module SurveyMonkeyApi
+    # Client class for api requests
+    class Client
+        include HTTParty
+        include SurveyMonkeyApi::Client::Users
+        include SurveyMonkeyApi::Client::Surveys
+
+        base_uri 'https://api.surveymonkey.net'
+        format :json
+
+        def initialize(_args = {})
+            access_token = ENV['SURVEY_MONKEY_TOKEN']
+            self.class.default_options.merge!(headers: { 'Authorization' => "Bearer #{access_token}", 'Content-Type' => 'application/json' })
+        end
+    end
+end

data/lib/surveymonkey/version.rb

@@ -1,3 +1,3 @@
 module SurveyMonkeyApi
-    VERSION = '0.1.0'.freeze
+    VERSION = '0.2.0'.freeze
 end

data/lib/surveymonkey.rb

@@ -1,5 +1,7 @@
-require 'surveymonkey/version'
+require_relative 'surveymonkey/version'
+require_relative 'surveymonkey/client'
 
 # Top-level module
 module SurveyMonkeyApi
+    class Failure < StandardError; end
 end

data/surveymonkey.gemspec

@@ -26,4 +26,5 @@ Gem::Specification.new do |spec|
     spec.add_development_dependency 'rake', '~> 10.0'
     spec.add_development_dependency 'rspec', '~> 3.0'
     spec.add_development_dependency 'rubocop', '~> 0.49.1'
+    spec.add_dependency 'httparty', '~> 0.15'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: survey_monkey_api
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Anton Bogdanov
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.49.1
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
 description: Actions with surveys in SurveyMonkey system
 email:
 - kortirso@gmail.com
@@ -85,6 +99,9 @@ files:
 - bin/console
 - bin/setup
 - lib/surveymonkey.rb
+- lib/surveymonkey/client.rb
+- lib/surveymonkey/client/surveys.rb
+- lib/surveymonkey/client/users.rb
 - lib/surveymonkey/version.rb
 - surveymonkey.gemspec
 homepage: https://github.com/kortirso/surveymonkey