formhub_ruby 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 19a10a14da1e872eccaf21412f6ba5dbfb4b577c
+  data.tar.gz: d0708177046b6a808fb1787023a4ad79203beda5
+SHA512:
+  metadata.gz: 08b626d2b17c11e413c3477ab3a7ab5ae65a1b5440c883e4f4c88f3f8d35d88233d65bdc7ff480d9bf3403ce3d1b21e22b748cf19d5c5d3c87e7d508d773d39b
+  data.tar.gz: edb9912b9fb3a5f7d4e809ec576a4e28b4414eeaca2b95eb399f1cdf14d67f21028344ec544134de428da3e4970edf837accd145d00cae2fbbf0c4f9037cd73b

data/.gitignore

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

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,8 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard :rspec do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { 'spec' }
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Loïc Seigland
+
+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,29 @@
+# FormhubRuby
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'formhub_ruby'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install formhub_ruby
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/formhub_ruby/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 new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+require 'rspec/core/rake_task'
+require 'bundler/gem_tasks'
+
+# Default directory to look in is `/specs`
+# Run with `rake spec`
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.rspec_opts = ['--color', '--format', 'nested']
+end
+
+task :default => :spec

data/formhub_ruby.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'formhub_ruby/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'formhub_ruby'
+  spec.version       = FormhubRuby::VERSION
+  spec.authors       = ['Loïc Seigland']
+  spec.email         = ['loic@loicseigland.ie']
+  spec.summary       = %q(Simple Client for the Formhub API)
+  # spec.description   = %q(TODO: Write a longer description. Optional.)
+  spec.homepage      = 'http://loicseigland.ie'
+  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.add_development_dependency 'bundler', '~> 1.5'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rspec-nc'
+  spec.add_development_dependency 'guard'
+  spec.add_development_dependency 'guard-rspec'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'pry-remote'
+  spec.add_development_dependency 'pry-nav'
+  spec.add_development_dependency 'vcr'
+  spec.add_development_dependency 'webmock'
+
+end

data/lib/formhub_ruby.rb

@@ -0,0 +1,18 @@
+require 'formhub_ruby/version'
+require 'formhub_ruby/configuration'
+require 'formhub_ruby/api_connector'
+
+module FormhubRuby
+
+  class << self
+    attr_writer :configuration
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+end

data/lib/formhub_ruby/api_connector.rb

@@ -0,0 +1,46 @@
+require 'net/http'
+require 'json'
+module FormhubRuby
+  class ApiConnector
+    attr_reader :formname, :filetype, :username, :password, :data
+
+    def initialize(args)  
+      @username = args[:username] || FormhubRuby.configuration.username
+      @password = args[:password] || FormhubRuby.configuration.password
+      @formname = args[:formname]
+      @filetype = args[:filetype] || 'json'
+    end
+
+    def fetch
+      # CAN DO THAT A LATER STAGE: Define different url format
+      # for different data point formats
+      # uri = URI(form_uri)         
+      uri = URI("http://formhub.org/#{@username}/forms/#{@formname}/api")
+      req = Net::HTTP::Get.new(uri)
+      req.basic_auth @username, @password
+      response = Net::HTTP.start(uri.hostname, uri.port) do |http|
+        http.request(req)
+      end
+
+      begin
+        @data = JSON.parse(response.body)
+      rescue
+        raise 'API connection error'
+      end
+    end
+
+    # private
+
+    # CAN DO THAT A LATER STAGE: Define different data point formats
+    # (now will default to JSON)
+
+    # def form_uri
+    #   case @filetype.downcase
+    #   when 'json' then "http://formhub.org/#{@username}/forms/#{@formname}/api"
+    #   when 'csv' then "http://formhub.org/#{@username}/forms/#{@formname}/data.csv"
+    #   when 'xls' then "http://formhub.org/#{@username}/forms/#{@formname}/data.xls"
+    #   end
+    # end
+  end
+end
+

data/lib/formhub_ruby/configuration.rb

@@ -0,0 +1,10 @@
+module FormhubRuby
+  class Configuration
+    attr_accessor :username, :password
+
+    def initialize(args={})
+      @username = args[:username]
+      @password = args[:password]
+    end
+  end
+end

data/lib/formhub_ruby/version.rb

@@ -0,0 +1,3 @@
+module FormhubRuby
+  VERSION = '0.0.1'
+end

data/spec/api_connectior_spec.rb

@@ -0,0 +1,30 @@
+require 'formhub_ruby'
+require 'spec_helper'
+require 'yaml'
+
+describe FormhubRuby::ApiConnector do
+
+  before :each do
+    credentials = YAML.load_file('spec/fixtures/test_credentials.yml')
+    FormhubRuby.configure do |config|
+      config.username = credentials['username']
+      config.password = credentials['password']
+    end
+  end
+
+  it 'successfully connects to the FormHub API and retrieve JSON Data' do
+    VCR.use_cassette 'successful_connection' do 
+      connection = FormhubRuby::ApiConnector.new(formname: 'survey')
+      connection.fetch
+      connection.data.should be_a_kind_of(Array)
+      connection.data[0].should be_a_kind_of(Object)
+    end
+  end
+
+  it "displays appropriate message if the JSON data is not successfully retrieved" do
+      stub_request(:any, "http://formhub.org/#{FormhubRuby.configuration.username}/forms/survey/api").to_return(:body => "NO JSON HERE")
+      connection = FormhubRuby::ApiConnector.new(formname: 'fake')
+      expect {connection.fetch}.to raise_error("API connection error")
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,35 @@
+require 'vcr'
+require 'webmock'
+require 'webmock/rspec'
+require 'factory_girl'
+
+RSpec.configure do |config|
+  FactoryGirl.find_definitions
+
+  config.include WebMock::API
+  config.before(:each) do
+    WebMock.reset!
+    VCR.configure do |c|
+      c.cassette_library_dir = 'spec/fixtures/vcr_cassettes'
+      c.allow_http_connections_when_no_cassette = true
+      c.hook_into :webmock
+      # c.before_record do |i|
+
+      #   i.response.headers.delete('Set-Cookie')
+      #   i.request.headers.delete('Authorization')
+
+      #   u = URI.parse(i.request.uri)
+      #   i.request.uri.sub!(%r{:\/\/.*#{Regexp.escape(u.host)}}, "://#{u.host}")
+
+      # end
+
+      # Matches authenticated requests regardless of their Basic
+      # auth string (https://user:pass@domain.tld)
+      # c.register_request_matcher :anonymized_uri do |request_1, request_2|
+      #   (URI(request_1.uri).port == URI(request_2.uri).port) &&
+      #     URI(request_1.uri).path == URI(request_2.uri).path
+      # end
+    end
+
+  end
+end

metadata

@@ -0,0 +1,215 @@
+--- !ruby/object:Gem::Specification
+name: formhub_ruby
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Loïc Seigland
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: rspec
+  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: rspec-nc
+  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: guard
+  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: guard-rspec
+  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: pry
+  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: pry-remote
+  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: pry-nav
+  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'
+description: 
+email:
+- loic@loicseigland.ie
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- formhub_ruby.gemspec
+- lib/formhub_ruby.rb
+- lib/formhub_ruby/api_connector.rb
+- lib/formhub_ruby/configuration.rb
+- lib/formhub_ruby/version.rb
+- spec/api_connectior_spec.rb
+- spec/client_spec.rb
+- spec/spec_helper.rb
+homepage: http://loicseigland.ie
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.0
+signing_key: 
+specification_version: 4
+summary: Simple Client for the Formhub API
+test_files:
+- spec/api_connectior_spec.rb
+- spec/client_spec.rb
+- spec/spec_helper.rb