prove 0.0.2

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in 
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Nick Baugh
+
+MIT License
+
+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,2 @@
+require "bundler/gem_tasks"
+Bundler::GemHelper.install_tasks

data/Readme.md

@@ -0,0 +1,162 @@
+
+# prove-ruby <sup>0.0.1</sup>
+
+[Prove](https://getprove.com/) API wrapper for Ruby.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'prove'
+```
+
+And then execute:
+
+```bash
+bundle
+```
+
+Or install it yourself:
+
+```bash
+gem install prove
+```
+
+And require:
+
+```ruby
+require 'prove'
+```
+
+## Usage
+
+### Quick Start 
+```ruby
+  #initialize client
+  Prove.api_key="test_APIKEY123"
+
+  #get existing verifications
+  verifications = Prove::Verification.list
+
+  #create verification
+  v = Prove::Verification.create(tel: "1234567890")
+
+  #verify with pin
+  v = v.verify(pin: 1337) #or Prove::Verification.verify(id: v.id, pin: 1337)
+
+  #get existing verification
+  v = v.retrieve #or Prove::Verification.retrieve(id: v.id) 
+
+  #verification result object
+  v.id # "awoeif128912938" 
+  v.tel # "1234567890"
+  v.text # true
+  v.call # false
+  v.verified # true
+
+  #create a verification object from scratch
+  v = Prove::Verification.new(id: "awoeif128912938", 
+                              tel:"1234567890", 
+                              text: true, 
+                              call: false, 
+                              verified: true)
+```
+
+### Configuration 
+Default config
+```ruby
+  Prove.api_key="test_APIKEY123"
+```
+
+Config with options
+```ruby
+  
+  Prove.configure(api_key: "test_APIKEY123", 
+                  logger: Rails.logger, 
+                  log_level: :debug, 
+                  faraday_adapter: :em_http)
+```
+
+Advanced config with direct access to faraday connection. ( **Advanced Users Only** See: [faraday middleware](https://github.com/lostisland/faraday#advanced-middleware-usage))
+
+```ruby
+  Prove.configure(api_key: "test_APIKEY123") do |cxn|
+        cxn.request  :url_encoded #required
+        cxn.response :logger, Rails.logger
+        cxn.response :json #required
+        cxn.response :raise_error 
+        cxn.adapter Faraday.default_adapter
+  end
+```
+
+
+### Method Flavors 
+
+Support for either positional params 
+
+```ruby
+  Prove::Verification.verify(v.id, 1337)
+```
+
+or named params ( **recommended** )
+
+```ruby
+  Prove::Verification.verify(id: v.id, pin: 1337)
+```
+
+## Testing
+
+Install dependencies
+
+```bash
+bundle
+```
+
+To run tests setup an env variable with your key
+
+```bash
+export PROVE=test_APIKEY123
+```
+
+and run:
+
+```bash
+bundle exec rspec spec
+```
+
+or
+
+```bash
+PROVE=test_KUrW834WfoDFlNMNN5FC53Z1Xb4 bundle exec rspec spec
+```
+
+## Contributors
+
+* Grant Warman <grant.warman@gmail.com>
+* Nick Baugh <niftylettuce@gmail.com>
+
+
+## License
+
+The MIT License
+
+Copyright (c) 2013- Prove <support@getprove.com> (https://getprove.com/)
+
+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/lib/prove.rb

@@ -0,0 +1,19 @@
+require 'prove/client'
+require 'prove/verification'
+module Prove
+  class << self
+    attr_reader :client
+    def api_key=(key)
+      if @client
+        @client.api_key = key
+      else
+        @client = Client.new(api_key: key)
+      end
+    end
+
+    def configure(options, &block)
+      @client = Client.new(options, &block)
+    end 
+  end
+
+end

data/lib/prove/client.rb

@@ -0,0 +1,54 @@
+require "faraday"
+require 'faraday_middleware'
+require "logger"
+
+module Prove
+  class Client
+    attr_accessor :api_key, :connection
+
+    DEFAULTS = {faraday_adapter: Faraday.default_adapter,
+      log_level: :warn,
+      logger: Logger.new(STDOUT),
+      scheme: :https,
+      port: 443,
+      host: 'getprove.com'}
+
+    def initialize(options={}, &block)
+      config = DEFAULTS.merge(options)
+
+      if !options.has_key?(:logger) or (options.has_key?(:log_level) and options.has_key?(:logger))
+        config[:logger].level = Logger.const_get(config[:log_level].to_s.upcase)
+      end
+
+ 
+      block = block_given? ? block : Proc.new do |cxn|
+        cxn.request  :url_encoded
+        cxn.response :logger, config[:logger] 
+        cxn.response :json
+        # cxn.response :raise_error  # raise exceptions on 40x, 50x responses
+        cxn.adapter config[:faraday_adapter] 
+      end
+      
+      url_builder = config[:scheme] == :http ? URI::HTTP : URI::HTTPS
+      url = url_builder.build(host: config[:host], port: config[:port])
+
+      @connection = Faraday.new(url, &block)     
+      @connection.headers['User-Agent'] = "Prove-Ruby"
+
+      self.api_key = config[:api_key]
+    end
+
+    def api_key=(key)
+      @api_key = key
+      @connection.basic_auth(@api_key, '')
+    end
+
+    def get(url, options = {}, &block)
+      return @connection.get(url, options, &block) 
+    end
+
+    def post(url, options = {}, &block)
+      return @connection.post(url, options, &block)
+    end
+  end
+end

data/lib/prove/verification.rb

@@ -0,0 +1,62 @@
+module Prove
+  class Verification
+    ACCESSORS = [:id, :tel, :text, :call, :verified]
+    attr_accessor *ACCESSORS
+
+    def initialize(attr_hash={})
+      attr_hash.each do |key, val|
+        self.instance_variable_set("@#{key}", val)
+      end
+    end
+
+    def self.create(*args)
+      options = args.last.is_a?(Hash) ? args.pop : {}
+      tel = args[0] || options[:tel]
+      from_json Prove.client.post('/api/v1/verify', {tel: tel}).body
+    end
+
+    def self.list
+      from_json_array Prove.client.get('/api/v1/verify').body
+    end
+
+    def self.verify(*args)
+      options = args.last.is_a?(Hash) ? args.pop : {}
+      id = args[0] || options[:id]
+      pin = args[1] || options[:pin]
+
+      from_json Prove.client.post('/api/v1/verify/' + id + '/pin', {pin: pin}).body
+    end
+
+    def self.retrieve(*args)
+      options = args.last.is_a?(Hash) ? args.pop : {}
+      id = args[0] || options[:id]
+      from_json Prove.client.get('/api/v1/verify/' + id).body
+    end
+
+    def verify(*args)
+      options = args.last.is_a?(Hash) ? args.pop : {}
+      pin = args[0] || options[:pin]
+      self.class.verify(self.id, pin)
+    end
+
+    def retrieve
+      self.class.retrieve(self.id)
+    end
+
+    def to_json
+      return {id: self.id, 
+        tel: self.tel,
+        text: self.text, 
+        call: self.call, 
+        verified: self.verified}.to_json
+    end
+
+    def self.from_json(verification_hash)
+      return Verification.new(verification_hash)
+    end
+
+    def self.from_json_array(verifications)
+      return verifications.map{|attr_hash| Verification.new(attr_hash)}
+    end
+  end
+end

data/lib/prove/version.rb

@@ -0,0 +1,3 @@
+module Prove
+  VERSION = "0.0.2"
+end

data/prove.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'prove/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "prove"
+  gem.version       = Prove::VERSION
+  gem.platform      = Gem::Platform::RUBY
+  gem.authors       = ["Nick Baugh", "Grant Warman"]
+  gem.email         = ["niftylettuce@gmail.com"]
+  gem.homepage      = "https://github.com/getprove/prove-ruby"
+  gem.description   = %q{Prove makes it easy to verify phone numbers with voice and SMS.}
+  gem.summary       = %q{Phone verification for developers.}
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+  gem.add_dependency("faraday", '>= 0.8.6')
+  gem.add_dependency("faraday_middleware", '~> 0.9.0')
+  gem.add_development_dependency "rspec", "~> 2.6"
+end

data/spec/client_spec.rb

@@ -0,0 +1,6 @@
+require 'prove'
+describe Prove::Client do
+  it "should be initializable" do
+    expect(Prove::Client.new).to_not be_nil
+  end
+end

data/spec/prove_spec.rb

@@ -0,0 +1,16 @@
+require 'prove'
+describe Prove do
+  it "should have an env variable with secret key" do
+    expect(ENV['PROVE']).to_not be_nil
+  end 
+
+  it "should be initializable with an api key" do
+    Prove.api_key = ENV['PROVE']
+    expect(Prove.client).to_not be_nil
+  end
+
+  it "should be configurable with an api key" do
+    Prove.configure(api_key: ENV['PROVE'])
+    expect(Prove.client).to_not be_nil
+  end
+end

data/spec/verification_spec.rb

@@ -0,0 +1,93 @@
+require 'prove'
+describe Prove::Verification do
+  RSpec::Matchers.define :be_a_populated_verification do
+    match do |v|
+      any_nil_attr = Prove::Verification::ACCESSORS.map{|i| v.send(i)}.any?(&:nil?)
+      !v.nil? and v.kind_of?(Prove::Verification) and !any_nil_attr
+    end
+
+    failure_message_for_should do |v|
+      if v.nil?
+        "expected that #{v} would not be nil" 
+      elsif !v.kind_of?(Prove::Verification)
+        "expected that #{v} was a kind of Prove::Verification"
+      else
+       nil_attr = Prove::Verification::ACCESSORS.map{|i| v.send(i)}.select(&:nil?)
+       "expected that #{v} would not have nil attributes #{nil_attr}"
+      end
+    end
+  end
+
+  before(:all) do
+    Prove.api_key = ENV['PROVE']
+  end
+
+  it "should be initializable" do
+    v = Prove::Verification.new({
+      id: "awoeif128912938",
+      tel: "1234567890",
+      text: true,
+      call: false,
+      verified: false
+    })
+    expect(v).to be_a_populated_verification
+  end
+
+  it "Verification#list should return a list of Verifications" do 
+    verifications = Prove::Verification.list
+    expect(verifications).to_not be_nil
+    expect(verifications).to be_kind_of Array
+  end
+
+  it "Verification#create should return a populated verification" do 
+    v = Prove::Verification.create("1234567890")
+    expect(v).to be_a_populated_verification
+    expect(v.verified).to be_false
+  end
+
+  it "Verification#create with hash should return a populated verification" do 
+    v = Prove::Verification.create(tel: "1234567890")
+    expect(v).to be_a_populated_verification
+    expect(v.verified).to be_false
+  end
+
+  it "Verification#verify with ordered params should return a populated verification" do 
+    v = Prove::Verification.create("1234567890")
+    v = Prove::Verification.verify(v.id, 1337) 
+    expect(v).to be_a_populated_verification
+    expect(v.verified).to be_true
+  end
+
+  it "Verification#verify with hash params should return a populated verification" do 
+    v = Prove::Verification.create("1234567890")
+    v = Prove::Verification.verify(id: v.id, pin: 1337) 
+    expect(v).to be_a_populated_verification
+    expect(v.verified).to be_true
+  end
+
+  it "#retrieve should return a populated verification" do 
+    v = Prove::Verification.create("1234567890")
+    v = v.retrieve
+    expect(v).to be_a_populated_verification
+  end
+
+  it "#verify should return a populated verification" do 
+    v = Prove::Verification.create("1234567890")
+    v = v.verify(1337) 
+    expect(v).to be_a_populated_verification
+    expect(v.verified).to be_true
+  end
+
+  it "#verify should return a populated verification" do 
+    v = Prove::Verification.create("1234567890")
+    v = v.verify(pin: 1337) 
+    expect(v).to be_a_populated_verification
+    expect(v.verified).to be_true
+  end
+
+  it "#retrieve should return a populated verification" do 
+    v = Prove::Verification.create("1234567890")
+    v = v.retrieve
+    expect(v).to be_a_populated_verification
+  end
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification 
+name: prove
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 2
+  version: 0.0.2
+platform: ruby
+authors: 
+- Nick Baugh
+- Grant Warman
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2013-05-09 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: faraday
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 51
+        segments: 
+        - 0
+        - 8
+        - 6
+        version: 0.8.6
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: faraday_middleware
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 59
+        segments: 
+        - 0
+        - 9
+        - 0
+        version: 0.9.0
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 2
+        - 6
+        version: "2.6"
+  type: :development
+  version_requirements: *id003
+description: Prove makes it easy to verify phone numbers with voice and SMS.
+email: 
+- niftylettuce@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- Rakefile
+- Readme.md
+- lib/prove.rb
+- lib/prove/client.rb
+- lib/prove/verification.rb
+- lib/prove/version.rb
+- prove.gemspec
+- spec/client_spec.rb
+- spec/prove_spec.rb
+- spec/verification_spec.rb
+homepage: https://github.com/getprove/prove-ruby
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: Phone verification for developers.
+test_files: 
+- spec/client_spec.rb
+- spec/prove_spec.rb
+- spec/verification_spec.rb