commcare_api 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ddc3cc72f11ad4fcedf7e4409bea1386d36a0a43
+  data.tar.gz: f9ae7c5b80257e75c079c239bb177422f0446bdf
+SHA512:
+  metadata.gz: 5178b640b4c2ae369169b4fb36e66e55dd78ecff0b75c612dc0ebe9aeeb49ce71486d023e9c9e55868d25a1c7c8dd7b2a91c293a27d7347ce5421d7178734b5f
+  data.tar.gz: 04d840828ab224267bb17d2b9c27a15630174284ab6418a3af0c25c262650182173ae8293d4907cf3b2a8451e23c4733d2fa571a94e7e9a92cc060e8cbcea838

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 commcare_api.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Guillaume Deflaux
+
+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 @@
+# CommcareApi
+
+A CommCare API wrapper in Ruby
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'commcare_api'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install commcare_api
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( http://github.com/gdeflaux/commcare_api/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 @@
+require "bundler/gem_tasks"

data/commcare_api.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'commcare_api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "commcare_api"
+  spec.version       = CommcareApi::VERSION
+  spec.authors       = ["Guillaume Deflaux"]
+  spec.email         = ["deflaux.guillaume@gmail.com"]
+  spec.summary       = "A CommCare API wrapper in Ruby"
+  spec.description   = "A CommCare API wrapper in Ruby"
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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_dependency "httpi"
+  spec.add_dependency "httpclient"
+end

data/lib/commcare_api.rb

@@ -0,0 +1,53 @@
+require "commcare_api/version"
+require "httpi"
+require "httpclient"
+
+module CommcareApi
+  CC_BASE_URL = "https://commcarehq.org/a"
+  
+  class CommcareConnector
+    def initialize(user, password, format="json", version="0.5")
+      @user = user
+      @password = password
+      @format = format
+      @version = "v#{version}"
+    end
+    
+    def get_cases(domain, options = {})
+      url = buil_url(domain, "case", options)
+      get_request(url)
+    end
+    
+    def get_case(domain, case_id, options = {})
+      url = buil_url(domain, "case/#{case_id}", options)
+      get_request(url)
+    end
+    
+    def get_forms(domain, options = {})
+      url = buil_url(domain, "form", options)
+      get_request(url)
+    end
+    
+    def get_form(domain, form_id, options = {})
+      url = buil_url(domain, "form/#{form_id}", options)
+      get_request(url)
+    end
+    
+  end
+  
+  private
+  
+  def get_request(url)
+    request = HTTPI::Request.new(url)
+    request.auth.digest(@user, @password)
+    response = HTTPI.get(request, :httpclient)
+  end
+  
+  def build_url(domain, action, options)
+    url = "#{CC_BASE_URL}/#{domain}/api/#{@version}/#{action}"
+    options = options.map {|k,v| "#{k.to_s}=#{v}"}.join("&")
+    url = "#{url}/?#{options}" if options.empty?
+    url
+  end
+
+end

data/lib/commcare_api/version.rb

@@ -0,0 +1,3 @@
+module CommcareApi
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: commcare_api
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Guillaume Deflaux
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-26 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: httpi
+  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: httpclient
+  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: A CommCare API wrapper in Ruby
+email:
+- deflaux.guillaume@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- commcare_api.gemspec
+- lib/commcare_api.rb
+- lib/commcare_api/version.rb
+homepage: ''
+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.1
+signing_key: 
+specification_version: 4
+summary: A CommCare API wrapper in Ruby
+test_files: []