typeform 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d87009da2181534474893ab6ee219ed1bd707f12
+  data.tar.gz: bc34b4ffce46935df80998c64d5e5922ebde4e07
+SHA512:
+  metadata.gz: d57c8ce69f4332557bcc6b5fbde0cc0aa5a14cb5b90d3310fdbd1a141aad634b2c7303ff12439985189b5bfd79f28ab3881d138838f3adaf83bf75d9bbb29931
+  data.tar.gz: 435d610d5cb499daf0d09a971ba2f5f8d8222534c4bf3259897cf4edc9357c356ff614cebb1e55d62bee01eb3af15b79a1e5d0eccaf091ffb257f4e1a7a21b75

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.DS_Store

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Philip De Smedt
+
+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/README.md

@@ -0,0 +1,48 @@
+# Typeform
+
+Typeform is a Ruby gem that provides a wrapper for interacting with the Typeform Data API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'typeform'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install typeform
+
+## Usage
+
+Please refer to the [Typeform Data API Documentation](http://helpcenter.typeform.com/hc/en-us/articles/200071986-Data-API) for more information about the API, or follow the examples below:
+
+```ruby
+require 'typeform'
+
+Typeform.api_key = ENV['TYPEFORM_API_KEY']
+typeform_id = "an_id_here"
+form = Typeform::Form.new(typeform_id)
+
+all_entries = form.all_entries
+incomplete_entries = form.incomplete_entries
+complete_entries = form.complete_entries
+
+# Fetches all complete entries since today
+newest_entries = form.complete_entries(since: Time.now.to_i)
+```
+
+For now, the wrapper returns the default format as returned by the Typeform Data API. I have some thoughts on how they should structure their data and how they can be build a [Hypermedia APIs](http://en.wikipedia.org/wiki/Hypermedia), but the current implementation allows you to build your custom logic on top of the responses (e.g. your pagination logic).
+
+## Contributing
+
+1. Fork it ( https://github.com/philipdesmedt/typeform/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/typeform.rb

@@ -0,0 +1,86 @@
+require "httparty"
+require "hashie"
+Hash.send :include, Hashie::Extensions
+
+require "typeform/version"
+require "typeform/form"
+
+module Typeform
+  class << self
+    # Allow Typeform.api_key = "..."
+    def api_key=(api_key)
+      Typeform.api_key = api_key
+    end
+
+    # Allow Typeform.base_uri = "..."
+    def base_uri=(uri)
+      Tyepform.base_uri uri
+    end
+  end
+
+  # Represents a Typeform API error and contains specific data about the error.
+  class TypeformError < StandardError
+    attr_reader :data
+    def initialize(data)
+      @data = Hashie::Mash.new(data)
+      super "The Typeform API responded with the following error - #{data}"
+    end
+  end
+
+  class ClientError < StandardError; end
+  class ServerError < StandardError; end
+  class BadRequest < TypeformError; end
+  class Unauthorized < StandardError; end
+  class NotFound < ClientError; end
+  class Unavailable < StandardError; end
+
+  class Typeform
+    include HTTParty
+
+    @@base_uri = "https://api.typeform.com/v0/"
+    @@api_key = ""
+    headers({ 
+      'User-Agent' => "typeform-rest-#{VERSION}",
+      'Content-Type' => 'application/json; charset=utf-8',
+      'Accept-Encoding' => 'gzip, deflate'
+    })
+    base_uri @@base_uri
+
+    class << self
+      # Get the API key (Typeform::Typeform.api_key)
+      def api_key; @@api_key end
+
+      # Set the API key
+      def api_key=(api_key)
+        return @@api_key unless api_key
+        @@api_key = api_key
+      end
+
+      # Get the Base URI.
+      def base_uri; @@base_uri end
+
+      def get(*args); handle_response super end
+      # No POST, PUT or DELETE for now - Read only Typeform API
+      # def post(*args); handle_response super end
+      # def put(*args); handle_response super end
+      # def delete(*args); handle_response super end
+
+      def handle_response(response) # :nodoc:
+        case response.code
+        when 400
+          raise BadRequest.new response.parsed_response
+        when 401
+          raise Unauthorized.new
+        when 404
+          raise NotFound.new
+        when 400...500
+          raise ClientError.new response.parsed_response
+        when 500...600
+          raise ServerError.new
+        else
+          response
+        end
+      end
+    end
+  end
+end

data/lib/typeform/form.rb

@@ -0,0 +1,40 @@
+require 'typeform'
+require 'json'
+
+module Typeform
+
+  class Form
+    attr_reader :form_id
+
+    def initialize(form_id)
+      @form_id = form_id
+    end
+
+    def all_entries
+      response = get
+      Hashie::Mash.new(response)
+    end
+
+    def complete_entries(params = {})
+      response = get(params.merge(completed: true))
+      Hashie::Mash.new(response)
+    end
+
+    def incomplete_entries(params = {})
+      response = get(params.merge(completed: false))
+      Hashie::Mash.new(response)
+    end
+
+    private
+      def get(params = nil)
+        params ||= {}
+        params[:key] = Typeform.api_key
+        Typeform.get uri, :query => params
+      end
+
+      def uri
+        "/form/#{form_id}"
+      end
+  end
+
+end

data/lib/typeform/version.rb

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

data/typeform.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'typeform/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "typeform"
+  spec.version       = Typeform::VERSION
+  spec.authors       = ["Philip De Smedt"]
+  spec.email         = ["philip.desmedt@gmail.com"]
+  spec.summary       = "A Ruby interface to the Typeform Data API"
+  spec.description   = "Implements the complete functionality of the Typeform Data API v0"
+  spec.homepage      = "https://github.com/philipdesmedt/typeform"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+  spec.required_ruby_version = '>= 1.9.2'
+  spec.required_rubygems_version = '>= 1.3.5'
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "vcr"
+  spec.add_development_dependency "webmock"
+  spec.add_runtime_dependency "hashie", "~> 3.0.0"
+  spec.add_runtime_dependency "httparty"
+  spec.add_runtime_dependency "json"
+end

metadata

@@ -0,0 +1,165 @@
+--- !ruby/object:Gem::Specification
+name: typeform
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Philip De Smedt
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: httparty
+  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: json
+  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: Implements the complete functionality of the Typeform Data API v0
+email:
+- philip.desmedt@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/typeform.rb
+- lib/typeform/form.rb
+- lib/typeform/version.rb
+- typeform.gemspec
+homepage: https://github.com/philipdesmedt/typeform
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.3.5
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.4
+signing_key: 
+specification_version: 4
+summary: A Ruby interface to the Typeform Data API
+test_files: []