surveygizmo 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,3 @@
+source 'http://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Bobby Uhlenbrock
+
+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/Rakefile

@@ -0,0 +1,4 @@
+#!/usr/bin/env rake
+
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/lib/surveygizmo.rb

@@ -0,0 +1,26 @@
+require 'surveygizmo/api'
+require 'surveygizmo/client'
+require 'surveygizmo/configuration'
+
+module Surveygizmo
+  extend Configuration
+  class << self
+    # Alias for Surveygizmo::Client.new
+    #
+    # @return [Surveygizmo::Client]
+    def new(options={})
+      Surveygizmo::Client.new(options)
+    end
+
+    # Delegate to Surveygizmo::Client
+    def method_missing(method, *args, &block)
+      return super unless new.respond_to?(method)
+      new.send(method, *args, &block)
+    end
+
+    def respond_to?(method, include_private = false)
+      new.respond_to?(method, include_private) || super(method, include_private)
+    end
+    
+  end
+end

data/lib/surveygizmo/api.rb

@@ -0,0 +1,23 @@
+require 'surveygizmo/configuration'
+require 'surveygizmo/connection'
+require 'surveygizmo/request'
+
+module Surveygizmo
+  # @private
+  class API
+    include Connection
+    include Request
+
+    # @private
+    attr_accessor *Configuration::VALID_OPTIONS_KEYS
+
+    # Creates a new API
+    def initialize(options={})
+      options = Surveygizmo.options.merge(options)
+      Configuration::VALID_OPTIONS_KEYS.each do |key|
+        send("#{key}=", options[key])
+      end
+    end
+    
+  end
+end

data/lib/surveygizmo/client.rb

@@ -0,0 +1,27 @@
+module Surveygizmo
+  # Wrapper for the Surveygizmo REST API
+  #
+  # @note All methods have been separated into modules and follow the same grouping used in {http://developer.surveygizmo.com/resources/rest-api-documentation-version-1-01/api-objects/ the Surveygizmo API Documentation}.
+  # @see http://developer.surveygizmo.com/resources/rest-api-documentation-version-1-01/
+  class Client < API
+    # Require client method modules after initializing the Client class in
+    # order to avoid a superclass mismatch error, allowing those modules to be
+    # Client-namespaced.
+    require 'surveygizmo/client/account'
+    require 'surveygizmo/client/account_user'
+    require 'surveygizmo/client/filter'
+    require 'surveygizmo/client/survey'
+    require 'surveygizmo/client/survey_campaign'
+    require 'surveygizmo/client/survey_response'
+
+    alias :api_endpoint :endpoint
+
+    include Surveygizmo::Client::Account
+    include Surveygizmo::Client::AccountUser
+    include Surveygizmo::Client::Filter
+    include Surveygizmo::Client::Survey
+    include Surveygizmo::Client::SurveyCampaign
+    include Surveygizmo::Client::SurveyResponse
+
+  end
+end

data/lib/surveygizmo/client/account.rb

@@ -0,0 +1,14 @@
+module Surveygizmo
+  class Client
+    # Defines methods related to a SurveyGizmo account
+    # @see http://developer.surveygizmo.com/resources/rest-api-documentation-version-1-01/api-objects/account/
+    module Account
+      
+      # Get details of authorized account
+      def account
+        get('account')
+      end
+      
+    end
+  end
+end

data/lib/surveygizmo/client/account_user.rb

@@ -0,0 +1,39 @@
+module Surveygizmo
+  class Client
+    # Defines methods related to a SurveyGizmo account user (not to be confused with a {Contact})
+    # @see http://developer.surveygizmo.com/resources/rest-api-documentation-version-1-01/api-object-accountuser/
+    module AccountUser
+      
+      # List all account users
+      def account_users
+        get('accountuser')
+      end
+      
+      # Returns account user details for a given id
+      # @param id [Integer, String] A SurveyGizmo AccountUser ID
+      def account_user(id)
+        get("accountuser/#{id}")
+      end
+      
+      # Create a new account user
+      # @param options [Hash] provide the :email, :username and :password
+      def create_account_user(options = {})
+        post('accountuser?_method=PUT', options)
+      end
+      
+      # Remove an account user
+      # @param id [Integer, String] A SurveyGizmo AccountUser ID
+      def delete_account_user(id)
+        post("accountuser/#{id}?_method=DELETE")
+      end
+      
+      # Change an account user
+      # @param id [Integer, String] A SurveyGizmo AccountUser ID
+      # @param options [Hash] provide the :email, :username and :password
+      def update_account_user(id, options = {})
+        post("accountuser/#{id}?_method=POST", options)
+      end
+      
+    end
+  end
+end

data/lib/surveygizmo/client/contact.rb

@@ -0,0 +1,26 @@
+module Surveygizmo
+  class Client
+    # Defines methods related to a SurveyGizmo contact
+    # @see http://developer.surveygizmo.com/resources/rest-api-documentation-version-1-01/api-object-contact/
+    module Contact
+      
+      # List all contacts
+      # @param survey_id [Integer, String] Specify the survey
+      # @param survey_campaign_id [Integer, String] Specify the campaign
+      def contacts(survey_id, survey_campaign_id)
+        get("survey/#{survey_id}/surveycampaign")
+      end
+      
+      # Returns contact details for a given id
+      # @param survey_id [Integer, String] Specify the survey
+      # @param survey_campaign_id [Integer, String] Specify the campaign
+      # @param id [Integer, String] Specify the user
+      def contact(survey_id, survey_campaign_id, id)
+        get("survey/#{survey_id}/surveycampaign/#{id}")
+      end
+      
+      # TODO: Create, Update, Delete
+      
+    end
+  end
+end

data/lib/surveygizmo/client/filter.rb

@@ -0,0 +1,16 @@
+module Surveygizmo
+  class Client
+    # Defines methods related to filtering search results
+    # @see http://developer.surveygizmo.com/resources/filtering-and-browsing-results/
+    module Filter
+      
+      # Format filters for the request querystring
+      # TODO: Not yet recursive
+      # @param filters [Hash] Filter(s) used to refine search
+      def formatted_filters(filters = {})
+        Hash[*filters.map{|key,value| ["filter[#{key}]", value]}.flatten]
+      end
+      
+    end
+  end
+end

data/lib/surveygizmo/client/survey.rb

@@ -0,0 +1,30 @@
+module Surveygizmo
+  class Client
+    # Defines methods related to a SurveyGizmo survey
+    # Polls, Quizzes, Forms, Registrations are all surveys with simple flags activated to change the behavior of the object
+    # @see http://developer.surveygizmo.com/resources/rest-api-documentation-version-1-01/api-object-survey/
+    module Survey
+      
+      # List all surveys, optionally filtered
+      # @param filters [Hash] Filter(s) used to refine search
+      def surveys(filters = {})
+        get('survey', formatted_filters(filters))
+      end
+      
+      # Temporary, until SG implements filtering by subtype
+      def polls
+        surveys.select { |s| s._subtype == 'Poll' }
+      end
+      
+      # Returns survey details for a given id
+      # @param id [Integer, String] A SurveyGizmo AccountUser ID
+      # @param metaonly [Boolean] Return only meta data
+      def survey(id, metaonly = false)
+        get("survey/#{id}", :metaonly => metaonly)
+      end
+      
+      # TODO: Create, Update, Delete
+      
+    end
+  end
+end

data/lib/surveygizmo/client/survey_campaign.rb

@@ -0,0 +1,24 @@
+module Surveygizmo
+  class Client
+    # Defines methods related to a SurveyGizmo survey campaign
+    # @see http://developer.surveygizmo.com/resources/rest-api-documentation-version-1-01/api-object-surveycampaign/
+    module SurveyCampaign
+      
+      # List all survey campaigns for a given survey
+      # @param survey_id [Integer, String] Specify the survey to the campaigns to get
+      def survey_campaigns(survey_id)
+        get("survey/#{survey_id}/surveycampaign")
+      end
+      
+      # Returns survey campaign details for a given id
+      # @param survey_id [Integer, String] Specify the survey to the campaigns to get
+      # @param id [Integer, String] Specify the campaign to get
+      def survey_campaign(survey_id, id)
+        get("survey/#{survey_id}/surveycampaign/#{id}")
+      end
+      
+      # TODO: Create, Update, Delete
+      
+    end
+  end
+end

data/lib/surveygizmo/client/survey_response.rb

@@ -0,0 +1,24 @@
+module Surveygizmo
+  class Client
+    # Defines methods related to a SurveyGizmo survey response
+    # @see http://developer.surveygizmo.com/resources/rest-api-documentation-version-1-01/api-object-api-object-surveyresponse/
+    module SurveyResponse
+      
+      # List all survey responses for a given survey
+      # @param survey_id [Integer, String] Specify the survey to the responses to get
+      def survey_responses(survey_id)
+        get("survey/#{survey_id}/surveyresponse")
+      end
+      
+      # Returns survey response details for a given id
+      # @param survey_id [Integer, String] Specify the survey to the response to get
+      # @param id [Integer, String] Specify the response to get
+      def survey_response(survey_id, id)
+        get("survey/#{survey_id}/surveyresponse/#{id}")
+      end
+      
+      # TODO: Create, Update, Delete
+      
+    end
+  end
+end

data/lib/surveygizmo/configuration.rb

@@ -0,0 +1,56 @@
+require 'surveygizmo/version'
+
+module Surveygizmo
+  # Defines constants and methods related to configuration
+  module Configuration
+    
+    # An array of valid keys in the options hash when configuring a {Surveygizmo::API}
+    VALID_OPTIONS_KEYS = [
+      :username,
+      :password,
+      :endpoint,
+      :user_agent].freeze
+     
+    # There is no default
+    DEFAULT_USERNAME = nil
+    
+    # There is no default
+    DEFAULT_PASSWORD = nil
+    
+    # The endpoint that will be used to connect if none is set
+    DEFAULT_ENDPOINT = 'https://restapi.surveygizmo.com/v1/'.freeze
+
+    # The value sent in the 'User-Agent' header if none is set
+    DEFAULT_USER_AGENT = "Surveygizmo Ruby Gem #{Surveygizmo::VERSION}".freeze
+    
+    # @private
+    attr_accessor *VALID_OPTIONS_KEYS
+    
+    # When this module is extended, set all configuration options to their default values
+    def self.extended(base)
+      base.reset
+    end
+
+    # Convenience method to allow configuration options to be set in a block
+    def configure
+      yield self
+    end
+
+    # Create a hash of options and their values
+    def options
+      options = {}
+      VALID_OPTIONS_KEYS.each{|k| options[k] = send(k)}
+      options
+    end
+
+    # Reset all configuration options to defaults
+    def reset
+      self.endpoint           = DEFAULT_ENDPOINT
+      self.username           = DEFAULT_USERNAME
+      self.password           = DEFAULT_PASSWORD
+      self.user_agent         = DEFAULT_USER_AGENT
+      self
+    end
+    
+  end
+end

data/lib/surveygizmo/connection.rb

@@ -0,0 +1,28 @@
+require 'faraday_middleware'
+require 'digest/md5'
+
+module Surveygizmo
+  # @private
+  module Connection
+    
+    private
+
+      def connection(temp_api_endpoint=nil)
+        options = {
+          :headers => { 'Accept' => 'application/json', 'User-Agent' => user_agent },
+          :ssl => { :verify => false },
+          :params => { :'user:md5' => "#{username}:#{Digest::MD5.hexdigest(password)}" }
+        }
+
+        options[:url] = temp_api_endpoint ? temp_api_endpoint : api_endpoint
+
+        Faraday.new(options) do |builder|
+          builder.use Faraday::Request::UrlEncoded
+          builder.use Faraday::Response::Mashify
+          builder.use Faraday::Response::ParseJson
+          builder.adapter(:net_http)
+        end
+      end
+    
+  end
+end

data/lib/surveygizmo/request.rb

@@ -0,0 +1,41 @@
+module Surveygizmo
+  # Defines HTTP request methods
+  module Request
+    
+    # Perform an HTTP GET request
+    def get(path, options={})
+      request(:get, path, options)
+    end
+
+    def post(path, options={}, temp_api_endpoint=nil)
+      request(:post, path, options, temp_api_endpoint)
+    end
+
+    # Perform an HTTP PUT request
+    def put(path, options={})
+      request(:put, path, options)
+    end
+
+    # Perform an HTTP DELETE request
+    def delete(path, options={})
+      request(:delete, path, options)
+    end
+
+    private
+
+      # Perform an HTTP request
+      def request(method, path, options, temp_api_endpoint=nil)
+        response = connection(temp_api_endpoint).send(method) do |request|
+          case method.to_sym
+          when :get, :delete
+            request.url(path, options)
+          when :post, :put
+            request.path = path
+            request.body = options unless options.empty?
+          end
+        end
+        response.body.data
+      end
+
+  end
+end

data/lib/surveygizmo/version.rb

@@ -0,0 +1,3 @@
+module Surveygizmo
+  VERSION = "0.0.1"
+end

data/readme.textile

@@ -0,0 +1,73 @@
+h1. The SurveyGizmo Ruby Gem
+
+A Ruby wrapper for the "SurveyGizmo REST API":http://developer.surveygizmo.com/resources/rest-api-documentation-version-1-01/
+
+h2. Installation
+
+@gem install surveygizmo@
+
+h2. Documentation
+
+http://rdoc.info/github/ample/surveygizmo
+
+h2. Usage
+
+<code>
+# Configure your Surveygizmo client
+Surveygizmo.configure do |config|
+  config.username = YOUR_USERNAME
+  config.password = YOUR_PASSWORD
+end
+</code>
+
+h2. To Do List
+
+This gem is very young, and not all endpoints have been implemented. Here's a brief overview of the progress so far (italics denotes lack of implementation):
+
+* Account
+** Show
+* Account User
+** Index
+** Show
+** Create
+** Update
+** Delete
+* Contact
+** Index
+** Show
+** _Create_
+** _Update_
+** _Delete_
+* Survey
+** Index
+** Show
+** _Create_
+** _Update_
+** _Delete_
+* Survey Campaign
+** Index
+** Show
+** _Create_
+** _Update_
+** _Delete_
+* Survey Response
+** Index
+** Show
+** _Create_
+** _Update_
+** _Delete_
+* _Survey Option_
+* _Survey Question_
+* _Survey Page_
+* _Survey Statistics_
+* _Email Message_
+
+Also, there aren't any tests yet. This is high on the priority list and should be coming soon.
+
+h2. Thanks
+
+This gem is heavily inspired by the Twitter gem and John Nunemaker's hard work.
+
+h2. Copyright
+
+Copyright (c) 2011 Bobby Uhlenbrock. See LICENSE for details.

data/surveygizmo.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path('../lib', __FILE__)
+require 'surveygizmo/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'surveygizmo'
+  s.version     = Surveygizmo::VERSION
+  s.authors     = ['Bobby Uhlenbrock']
+  s.email       = ['developers@helloample.com']
+  s.homepage    = 'http://github.com/ample/surveygizmo'
+  s.summary     = %q{A Ruby wrapper for the SurveyGizmo REST API}
+  s.description = %q{A Ruby wrapper for the SurveyGizmo REST API}
+  s.rubyforge_project = 'surveygizmo'
+  
+  # Development Gems
+  # s.add_development_dependency 'rspec'
+  # Gems
+  s.add_dependency 'hashie', '~> 1.1.0'
+  s.add_dependency 'faraday', '~> 0.7.4'
+  s.add_dependency 'faraday_middleware', '~> 0.7.0'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ['lib']
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: surveygizmo
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Bobby Uhlenbrock
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-12-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: &70230798285560 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70230798285560
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: &70230798284520 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.4
+  type: :runtime
+  prerelease: false
+  version_requirements: *70230798284520
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: &70230798283660 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70230798283660
+description: A Ruby wrapper for the SurveyGizmo REST API
+email:
+- developers@helloample.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- Rakefile
+- lib/surveygizmo.rb
+- lib/surveygizmo/api.rb
+- lib/surveygizmo/client.rb
+- lib/surveygizmo/client/account.rb
+- lib/surveygizmo/client/account_user.rb
+- lib/surveygizmo/client/contact.rb
+- lib/surveygizmo/client/filter.rb
+- lib/surveygizmo/client/survey.rb
+- lib/surveygizmo/client/survey_campaign.rb
+- lib/surveygizmo/client/survey_response.rb
+- lib/surveygizmo/configuration.rb
+- lib/surveygizmo/connection.rb
+- lib/surveygizmo/request.rb
+- lib/surveygizmo/version.rb
+- readme.textile
+- surveygizmo.gemspec
+homepage: http://github.com/ample/surveygizmo
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: surveygizmo
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: A Ruby wrapper for the SurveyGizmo REST API
+test_files: []