dalia_api_survey_platform 0.0.9

data/etc/fake_responses/send_survey.json

@@ -0,0 +1,24 @@
+{
+  "survey": {
+    "id": "001",
+    "title": "The survey 001",
+    "tagline": "This is an explanation of the survey",
+    "prequalification": "This survey require you to be a sport man older than 40",
+    "kind": "mr_survey",
+    "published": false,
+    "cap_completions": 10,
+    "credits": {
+      "kind": "stars",
+      "amount": "280"
+    },
+    "questions": [
+      {
+        "id": "Qa01e47",
+        "kind": "page",
+        "body": {
+          "page": "The page"
+        }
+      }
+    ]
+  }
+}

data/etc/fake_responses/update_survey.json

@@ -0,0 +1,23 @@
+{
+  "survey": {
+    "id": "001",
+    "title": "The survey 001",
+    "tagline": "This is an explanation of the survey",
+    "prequalification": "This survey require you to be a sport man older than 40",
+    "kind": "mr_survey",
+    "published": false,
+    "credits": {
+      "kind": "stars",
+      "amount": "280"
+    },
+    "questions": [
+      {
+        "id": "Qa01e47",
+        "kind": "page",
+        "body": {
+          "page": "The page"
+        }
+      }
+    ]
+  }
+}

data/lib/dalia_api_survey_platform.rb

@@ -0,0 +1,15 @@
+require "httparty"
+require "ostruct"
+require "json"
+require "recursive_open_struct"
+
+require_relative "dalia_api_survey_platform/version"
+require_relative "dalia_api_survey_platform/http_client"
+require_relative "dalia_api_survey_platform/json_extension"
+require_relative "dalia_api_survey_platform/log"
+require_relative "dalia_api_survey_platform/exception"
+require_relative "dalia_api_survey_platform/client"
+require_relative "dalia_api_survey_platform/mock_client"
+
+module Dalia::Api::SurveyPlatform
+end

data/lib/dalia_api_survey_platform/client.rb

@@ -0,0 +1,136 @@
+class Dalia::Api::SurveyPlatform::Client
+  attr_accessor :options
+  attr_reader :log
+  attr_reader :response
+
+  def initialize(opts = {})
+    @options = {
+      :debug_mode => false,
+      :api_host => "http://daliaresearch.com"
+    }.merge!(opts)
+
+    @log = Dalia::Api::SurveyPlatform::Log.new(options[:debug_mode])
+
+    log.log_options(options)
+
+    check_required_options(options, :api_host, :account_id)
+  end
+
+  def fetch_surveys
+    make_request_fetch_surveys({})
+  end
+
+  def fetch_survey(opts)
+    check_required_options(opts, :survey_id)
+    make_request_fetch_survey(opts)
+  end
+
+  def send_survey(opts)
+    check_required_options(opts, :data)
+    make_request_send_survey(opts)
+  end
+
+  def update_survey(opts)
+    check_required_options(opts, :survey_id, :data)
+    make_request_update_survey(opts)
+  end
+
+  def fetch_completions(opts)
+    check_required_options(opts, :survey_id)
+    make_request_fetch_completions(opts)
+  end
+
+  def fetch_completions_csv(opts)
+    check_required_options(opts, :survey_id)
+    make_request_fetch_completions_csv(opts)
+  end
+
+  def fetch_completion(opts)
+    check_required_options(opts, :survey_id, :completion_id)
+    make_request_fetch_completion(opts)
+  end
+
+  def fetch_survey_price(opts)
+    check_required_options(opts)
+    make_request_fetch_survey_price(opts)
+  end
+
+  def create_query(opts)
+    check_required_options(opts, :survey_id, :question_id)
+    make_request_create_query(opts)
+  end
+
+private
+
+  def make_request_fetch_surveys(query)
+    make_request("/api/control_panel/control_panel_users/1/researcher_users/#{@options[:account_id]}/surveys", query)
+  end
+
+  def make_request_fetch_survey(query)
+    make_request("/api/control_panel/control_panel_users/1/researcher_users/#{@options[:account_id]}/surveys/#{query.delete(:survey_id)}", query)
+  end
+
+  def make_request_send_survey(query)
+    make_request("/api/control_panel/control_panel_users/1/researcher_users/#{@options[:account_id]}/surveys/", query, :method => :post)
+  end
+
+  def make_request_update_survey(query)
+    make_request("/api/control_panel/control_panel_users/1/researcher_users/#{@options[:account_id]}/surveys/#{query.delete(:survey_id)}", query, :method => :put)
+  end
+
+  def make_request_fetch_completions(query)
+    make_request("/api/control_panel/control_panel_users/1/researcher_users/#{@options[:account_id]}/surveys/#{query.delete(:survey_id)}/completions", query)
+  end
+
+  def make_request_fetch_completions_csv(query)
+    make_request("/api/control_panel/control_panel_users/1/researcher_users/#{@options[:account_id]}/surveys/#{query.delete(:survey_id)}/completions/index_to_csv", query)
+  end
+
+  def make_request_fetch_completion(query)
+    make_request("/api/control_panel/control_panel_users/1/researcher_users/#{@options[:account_id]}/surveys/#{query.delete(:survey_id)}/completions/#{query.delete(:completion_id)}", query)
+  end
+
+  def make_request_fetch_survey_price(query)
+    make_request("/api/control_panel/control_panel_users/1/researcher_users/#{@options[:account_id]}/surveys/price", query, :method => :post)
+  end
+
+  def make_request_create_query(query)
+    make_request("/api/control_panel/control_panel_users/1/researcher_users/#{@options[:account_id]}/surveys/#{query.delete(:survey_id)}/query", query)
+  end
+
+  def make_request(api_path, query, opts = {})
+    opts[:method] ||= :get
+
+    api_url = "#{options[:api_host]}#{api_path}"
+
+    log.debug "api_url: #{api_url}"
+    log.debug "api_query: #{query.inspect}"
+
+    response =
+      case opts[:method]
+      when :get then Dalia::Api::SurveyPlatform::HTTPClient.get(api_url, :query => query)
+      when :post then Dalia::Api::SurveyPlatform::HTTPClient.post(api_url, :body => query)
+      when :put then Dalia::Api::SurveyPlatform::HTTPClient.put(api_url, :body => query)
+      end
+
+    log.log_response response
+
+    raise Dalia::Api::SurveyPlatform::Exception, response.message if response.code != 200
+
+    if response.content_type == "application/json"
+      JSON.parse_sym(response.body)
+    else
+      response.body
+    end
+  end
+
+  def check_required_options(options_hash, *required_options)
+    errors =
+      required_options.map do |required_option|
+        "#{required_option} required" if !options_hash[required_option]
+      end.compact.join(", ")
+
+    raise Dalia::Api::SurveyPlatform::Exception, errors if !errors.empty?
+  end
+
+end

data/lib/dalia_api_survey_platform/exception.rb

@@ -0,0 +1,2 @@
+class Dalia::Api::SurveyPlatform::Exception < Exception
+end

data/lib/dalia_api_survey_platform/http_client.rb

@@ -0,0 +1,4 @@
+class Dalia::Api::SurveyPlatform::HTTPClient
+  include HTTParty
+  default_timeout 6000
+end

data/lib/dalia_api_survey_platform/json_extension.rb

@@ -0,0 +1,5 @@
+module JSON
+  def self.parse_sym(source)
+    self.parse(source, :symbolize_names => true)
+  end
+end

data/lib/dalia_api_survey_platform/log.rb

@@ -0,0 +1,41 @@
+class Dalia::Api::SurveyPlatform::Log
+  attr_reader :debug_mode
+
+  def initialize(debug_mode = true)
+    @debug_mode = debug_mode
+  end
+
+  def debug(message)
+    return unless debug_mode
+
+    result = "Dalia::Api::SurveyPlatform [#{Time.now.strftime("%Y-%m-%d %H:%M:%S")}]: #{message}"
+
+    if defined? ::Rails
+      ::Rails.logger.info result
+    else
+      Kernel.puts result
+    end
+  end
+
+  def log_options(options)
+    debug "Options:"
+    debug "-----------"
+    options.each { |k,v| debug "#{k}: #{v}" }
+  end
+
+  def log_response(response)
+    if response.content_type == "application/json"
+      body = JSON.pretty_generate(JSON.parse_sym(response.body))
+    else
+      body = response.body
+    end
+
+    debug "Response:"
+    debug "-----------"
+    debug "response.request: #{response.request.last_uri}"
+    debug "response.body: #{body}"
+    debug "response.content_type: #{response.content_type}"
+    debug "response.code: #{response.code}"
+    debug "response.message: #{response.message}"
+  end
+end

data/lib/dalia_api_survey_platform/mock_client.rb

@@ -0,0 +1,79 @@
+class Dalia::Api::SurveyPlatform::MockClient < Dalia::Api::SurveyPlatform::Client
+  def initialize(opts = {})
+    opts = {
+      :account_id => "ACCOUNT_ID"
+    }.merge(opts)
+
+    super(opts)
+
+    log.debug "Initialize MockClient"
+  end
+
+  def make_request_fetch_surveys(query)
+    log.debug "make_request_fetch_surveys FAKE"
+    response("fetch_surveys.json")
+  end
+
+  def make_request_fetch_survey(query)
+    log.debug "make_request_fetch_survey FAKE"
+    response("fetch_survey.json")
+  end
+
+  def make_request_send_survey(query)
+    log.debug "make_request_send_survey FAKE"
+    response("send_survey.json")
+  end
+
+  def make_request_update_survey(query)
+    log.debug "make_request_update_survey FAKE"
+    response("update_survey.json")
+  end
+
+  def make_request_fetch_completions(query)
+    log.debug "make_request_fetch_completions FAKE"
+    response("fetch_completions.json")
+  end
+
+  def make_request_fetch_completions_csv(query)
+    log.debug "make_request_fetch_completions_csv FAKE"
+    response("fetch_completions.csv")
+  end
+
+  def make_request_fetch_completion(query)
+    log.debug "make_request_fetch_completion FAKE"
+    response("fetch_completion.json")
+  end
+
+  def make_request_fetch_survey_price(query)
+    log.debug "make_request_fetch_survey_price FAKE"
+    response("fetch_survey_price.json")
+  end
+
+  def make_request_create_query(query)
+    log.debug "make_request_create_query FAKE"
+    response("create_query.json")
+  end
+
+private
+
+  def response(file_response)
+    response =
+      RecursiveOpenStruct.new(
+        :body => File.read("#{File.dirname(__FILE__)}/../../etc/fake_responses/#{file_response}"),
+        :code => 200,
+        :content_type => file_response.match(/\.json$/) ? "application/json" : "text/csv",
+        :message => "<message>",
+        :request => {
+          :last_url => "<last_url>"
+        }
+      )
+
+    log.log_response response
+
+    if response.content_type == "application/json"
+      JSON.parse_sym(response.body)
+    else
+      response.body
+    end
+  end
+end

data/lib/dalia_api_survey_platform/version.rb

@@ -0,0 +1,7 @@
+module Dalia
+  module Api
+    module SurveyPlatform
+      VERSION = "0.0.9"
+    end
+  end
+end

data/test/client_test.rb

@@ -0,0 +1,138 @@
+require_relative "test_helper"
+
+class ClientTest < MiniTest::Unit::TestCase
+  def setup
+    FakeWeb.allow_net_connect = false
+    @client_opts = { :account_id => "RESEARCHER_ACCOUNT_UUID" }
+
+    @client = Dalia::Api::SurveyPlatform::Client.new @client_opts
+  end
+
+  def test_fetch_surveys
+    FakeWeb.register_uri(
+      :get,
+      "http://daliaresearch.com/api/control_panel/control_panel_users/1/researcher_users/RESEARCHER_ACCOUNT_UUID/surveys",
+      :body => File.read("#{FIXTURES}/fake_responses/fetch_surveys.json"),
+      :content_type => "application/json",
+      :status => ["200", "Success"]
+    )
+
+    response = @client.fetch_surveys
+
+    assert_equal(3, response[:surveys].length)
+  end
+
+  def test_fetch_survey
+    FakeWeb.register_uri(
+      :get,
+      "http://daliaresearch.com/api/control_panel/control_panel_users/1/researcher_users/RESEARCHER_ACCOUNT_UUID/surveys/SURVEY_UUID",
+      :body => File.read("#{FIXTURES}/fake_responses/fetch_survey.json"),
+      :content_type => "application/json",
+      :status => ["200", "Success"]
+    )
+
+    response = @client.fetch_survey(:survey_id => "SURVEY_UUID")
+
+    assert_equal(4, response[:survey][:questions].length)
+  end
+
+  def test_send_survey
+    FakeWeb.register_uri(
+      :post,
+      "http://daliaresearch.com/api/control_panel/control_panel_users/1/researcher_users/RESEARCHER_ACCOUNT_UUID/surveys/",
+      :body => File.read("#{FIXTURES}/fake_responses/send_survey.json"),
+      :content_type => "application/json",
+      :parameters => { :data => "DATA" },
+      :status => ["200", "Success"]
+    )
+
+    response = @client.send_survey(:data => "DATA")
+
+    assert_equal("280", response[:survey][:credits][:amount])
+  end
+
+  def test_update_survey
+    FakeWeb.register_uri(
+      :put,
+      "http://daliaresearch.com/api/control_panel/control_panel_users/1/researcher_users/RESEARCHER_ACCOUNT_UUID/surveys/SURVEY_UUID",
+      :body => File.read("#{FIXTURES}/fake_responses/send_survey.json"),
+      :content_type => "application/json",
+      :parameters => { :survey_id => "SURVEY_UUID", :data => "DATA" },
+      :status => ["200", "Success"]
+    )
+
+    response = @client.update_survey(:survey_id => "SURVEY_UUID", :data => "DATA")
+
+    assert_equal("280", response[:survey][:credits][:amount])
+  end
+
+  def test_fetch_completions
+    FakeWeb.register_uri(
+      :get,
+      "http://daliaresearch.com/api/control_panel/control_panel_users/1/researcher_users/RESEARCHER_ACCOUNT_UUID/surveys/SURVEY_UUID/completions",
+      :body => File.read("#{FIXTURES}/fake_responses/fetch_completions.json"),
+      :content_type => "application/json",
+      :status => ["200", "Success"]
+    )
+
+    response = @client.fetch_completions(:survey_id => "SURVEY_UUID")
+
+    assert_equal(3, response[:completions].length)
+  end
+
+  def test_fetch_completions_csv
+    FakeWeb.register_uri(
+      :get,
+      "http://daliaresearch.com/api/control_panel/control_panel_users/1/researcher_users/RESEARCHER_ACCOUNT_UUID/surveys/SURVEY_UUID/completions/index_to_csv",
+      :body => File.read("#{FIXTURES}/fake_responses/fetch_completions.csv"),
+      :content_type => "text/csv",
+      :status => ["200", "Success"]
+    )
+
+    response = @client.fetch_completions_csv(:survey_id => "SURVEY_UUID")
+
+    assert_equal(8, response.lines.length)
+  end
+
+  def test_fetch_completion
+    FakeWeb.register_uri(
+      :get,
+      "http://daliaresearch.com/api/control_panel/control_panel_users/1/researcher_users/RESEARCHER_ACCOUNT_UUID/surveys/SURVEY_UUID/completions/COMPLETION_UUID",
+      :body => File.read("#{FIXTURES}/fake_responses/fetch_completion.json"),
+      :content_type => "application/json",
+      :status => ["200", "Success"]
+    )
+
+    response = @client.fetch_completion(:survey_id => "SURVEY_UUID", :completion_id => "COMPLETION_UUID")
+
+    assert_equal("completed", response[:completion][:state])
+  end
+
+  def test_fetch_survey_price
+    FakeWeb.register_uri(
+      :post,
+      "http://daliaresearch.com/api/control_panel/control_panel_users/1/researcher_users/RESEARCHER_ACCOUNT_UUID/surveys/price",
+      :body => File.read("#{FIXTURES}/fake_responses/fetch_survey_price.json"),
+      :content_type => "application/json",
+      :status => ["200", "Success"]
+    )
+
+    response = @client.fetch_survey_price(:account_id => "RESEARCHER_ACCOUNT_UUID")
+
+    assert_equal(1.0, response[:price][:total])
+  end
+
+  def test_create_query
+    FakeWeb.register_uri(
+      :get,
+      "http://daliaresearch.com/api/control_panel/control_panel_users/1/researcher_users/RESEARCHER_ACCOUNT_UUID/surveys/SURVEY_UUID/query?question_id=QUESTION_UUID",
+      :body => File.read("#{FIXTURES}/fake_responses/create_query.json"),
+      :content_type => "application/json",
+      :status => ["200", "Success"]
+    )
+
+    response = @client.create_query(:survey_id => "SURVEY_UUID", :question_id => "QUESTION_UUID")
+
+    assert_equal("Qb5faf2", response[:question_id])
+  end
+end