ask-ruby 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c0ee18737c0d5e8e62a41fe19be69aed8e995da0
+  data.tar.gz: 33796d2f34300304d34bb802cc151e5cea0fc7e1
+SHA512:
+  metadata.gz: e86478a7e70241147eb8080de2aac466e806a143c72e0c3841eb32404b51dcb2daa2f6903ad9f8fd2e7138bbf5b4b2afbe1d734a76969a272645c12ea14350e6
+  data.tar.gz: e1d205d3071994cf93c3b3750f1256cca59f0df26eb8b25dc7539d75852848d53ca7a06053c1ff4c6afd3076997a8897e01cdab51018dfa6542ea17d355c68b5

data/.gitignore

@@ -0,0 +1,3 @@
+.DS_Store
+.bundle
+Gemfile.lock

data/.rspec

@@ -0,0 +1 @@
+--profile

data/.ruby-version

@@ -0,0 +1 @@
+2.0.0-p195

data/Gemfile

@@ -0,0 +1,14 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development do
+  gem 'debugger'
+end
+
+group :test do
+  gem 'awesome_print'
+  gem 'fuubar'
+  gem 'rspec', '~>2.13.0'
+  gem 'webmock', '>= 1.8.0', '< 1.10'
+end

data/README.md

@@ -0,0 +1,31 @@
+# The ask. Ruby Client
+
+## Initialization
+
+Intialize the library with your API key.
+
+If using Rails, just create `config/initializers/ask.rb`.  If using anything else, make sure to require the file.
+
+```
+Ask.api_token = '12345678901234567890'
+```
+
+## NPS
+
+### Schedule a survey to go out now.
+
+```
+Ask.schedule_nps('test@example.com')
+```
+
+Name, delay and properties are optional.
+
+```
+Ask.schedule_nps('test@example.com', 'Test User', '1 day', { cohort: 'facebook', location: '1600 Pennsylvania Ave, Washington DC 20001', tags: 'foo, bar, baz'})
+```
+
+### Schedule a survey to go out in a week
+
+```
+Ask.schedule_nps('test@example.com, 'Test User', 'one week', { ... })
+```

data/Rakefile

@@ -0,0 +1,7 @@
+# lib = File.expand_path('../lib', __FILE__)
+# $LOAD_PATH.unshift(lib)
+
+require 'rubygems'
+require "bundler/setup"
+
+Dir[File.join(File.dirname(__FILE__),'lib/tasks/*.rake')].each { |f| load f }

data/ask-ruby.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "ask-ruby"
+  s.version     = "0.0.2"
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Ian Hunter"]
+  s.email       = ["ian@asksurveys.com"]
+  s.homepage    = "https://github.com/askbetter/ask-ruby"
+  s.summary     = %q{ask. Ruby Library}
+  s.description = %q{Ruby library for integrating ask.}
+
+  s.rubyforge_project = s.name
+
+  s.required_ruby_version     = '>= 1.9.3'
+
+  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"]
+
+  s.add_dependency 'activesupport'
+  s.add_dependency 'faraday'
+  s.add_dependency 'faraday_middleware'
+end

data/lib/ask.rb

@@ -0,0 +1,40 @@
+require 'faraday'
+require 'faraday_middleware'
+
+module Ask
+  extend self
+
+  API_URL = "https://api.asksurveys.com/"
+
+  attr_accessor :api_token
+  
+  # Sends a POST to the Asksurveys API to schedule a satisfaction survey to be sent
+  #   after a set amount of time.
+  #
+  # @see http://asksurveys.com/docs
+  #
+  # @param [User] user The user to send a survey to.
+  # @param [FixNum] delay How long to wait before sending the survey.
+  # @param [Hash] properties Additional properties to send about
+  #   this user, purchase, item, etc.
+  def schedule_nps(email, name=nil, delay=nil, properties = {})
+    unless defined?(Ask.api_token)
+      raise "Make sure to set the API key before using the library: Ask.key = '1234567890'"
+    end
+
+    connection = Faraday.new(url: API_URL) do |faraday|
+      faraday.basic_auth api_token, ''
+      faraday.request    :url_encoded
+      faraday.response   :json # Parses response bodies as json.
+      faraday.adapter    Faraday.default_adapter
+    end
+
+    payload = {}
+    payload[:email] = email
+    payload[:name] = name if name
+    payload[:schedule_at] = delay if delay
+    payload[:properties] = properties
+
+    connection.post "/v1/nps.json", payload
+  end
+end

data/spec/ask_spec.rb

@@ -0,0 +1,13 @@
+require "spec_helper"
+
+describe Ask, ".schedule_nps" do
+  describe "the response" do
+    it "is successful and contains all appropriate keys" do
+      response = Ask.schedule_nps('test@example.com', 'test', 'one week', { foo: "bar" })
+
+      response.status.should             == 201
+      response.body['email'].should      == 'someone@example.com'
+      response.body['properties'].should == { "foo" => "bar" }
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'webmock/rspec'
+require 'ask'
+
+Ask.api_token = 'fake234823489234897234789'
+
+stubs = Faraday::Adapter::Test::Stubs.new do |stub|
+  stub.get('/v1/nps.json') { [201, {}, ''] }
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: ask-ruby
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Ian Hunter
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ruby library for integrating ask.
+email:
+- ian@asksurveys.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .ruby-version
+- Gemfile
+- README.md
+- Rakefile
+- ask-ruby.gemspec
+- lib/ask.rb
+- spec/ask_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/askbetter/ask-ruby
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: ask-ruby
+rubygems_version: 2.0.2
+signing_key: 
+specification_version: 4
+summary: ask. Ruby Library
+test_files:
+- spec/ask_spec.rb
+- spec/spec_helper.rb
+has_rdoc: