fulcrum 0.1.2

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/.rvmrc

@@ -0,0 +1 @@
+rvm use ruby-1.9.3@fulcrum_api

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Chris Hall
+
+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,123 @@
+# Fulcrum
+
+Fulcrum API Gem
+
+## Requirements
+
+ruby 1.9.x
+a [fulcrum user account](http://web.fulcrumapp.com)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'fulcrum'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fulcrum
+
+## Configuration
+
+    Fulcrum::Api.configure do |config|
+      config.uri = 'http://web.fulcrumapp.com/api/v2'
+      config.key = 'your_api_key'
+    end
+
+## Forms
+
+    Fulcrum::Form.all(opts)
+    # opts = { 'page' => page_number, 'schema' => true_or_false }
+
+    Fulcrum::Form.find(id, opts)
+    # opts = { 'include_foreign_elements' => true_or_false }
+
+    Fulcrum::Form.create(form)
+    # form = { 'form' => { ... } }
+
+    Fulcrum::Form.update(id, form)
+    # form = { 'form' => { ... } }
+
+    Fulcrum::Form.delete(id)
+
+## Records
+
+    Fulcrum::Record.all(opts)
+    # opts = { 'page' => page_number,
+    #          'form_id' => form_id,
+    #          'bounding_box' => 'lat_bottom,lng_left,lat_top,lng_right',
+    #          'updated_since' => date_since_epoch_in_seconds }
+
+    Fulcrum::Record.find(id)
+    Fulcrum::Record.create(record)
+    # record = { 'record' => { ... } }
+
+    Fulcrum::Record.update(id, record)
+    # record = { 'record' => { ... } }
+
+    Fulcrum::Record.delete(id)
+
+## Photos
+
+    Fulcrum::Photo.find(access_key, opts)
+    # opts = { 'format' => 'json|image' }
+
+    Fulcrum::Photo.thumbnail(access_key, opts)
+    # opts = { 'format' => 'json|image' }
+
+    Fulcrum::Photo.create(photo, content_type, unique_id, label)
+
+    Fulcrum::Photo.delete(access_key)
+
+## Choice Lists
+
+    Fulcrum::ChoiceList.all(opts)
+    # opts = { 'page' => page_number }
+
+    Fulcrum::ChoiceList.find(id)
+
+    Fulcrum::ChoiceList.create(choice_list)
+    # choice_list = { 'choice_list' => { ... } }
+
+    Fulcrum::ChoiceList.update(id, choice_list)
+    # choice_list = { 'choice_list' => { ... } }
+
+    Fulcrum::ChoiceList.delete(id)
+
+## Classification Sets
+
+    Fulcrum::ClassificationSet.all(opts)
+    # opts = { 'page' => page_number }
+
+    Fulcrum::ClassificationSet.find(id)
+
+    Fulcrum::ClassificationSet.create(classification_set)
+    # classification_set = { 'classification_set' => { ... } }
+
+    Fulcrum::ClassificationSet.update(id, classification_set)
+    # classification_set = { 'classification_set' => { ... } }
+
+    Fulcrum::ClassificationSet.delete(id)
+
+## Members
+
+    Fulcrum::Member.all(opts)
+    # opts = { 'page' => page_number }
+
+    Fulcrum::Member.find(id)
+
+## Extra Reading
+
+  [Fulcrum API docs](http://developer.fulcrumapp.com/api/fulcrum-api.html)
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,8 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new
+
+task :default => :spec
+task :test => :spec

data/fulcrum.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/fulcrum/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Chris Hall"]
+  gem.email         = ["chris@spatialnetworks.com"]
+  gem.description   = %q{Fulcrum API Gem}
+  gem.summary       = %q{Fulcrum API Gem}
+  gem.homepage      = "http://docs.fulcrumapp.com/"
+
+  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.name          = "fulcrum"
+  gem.require_paths = ["lib"]
+  gem.version       = Fulcrum::VERSION
+  
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'webmock'
+  gem.add_development_dependency 'debugger'
+  
+  gem.add_dependency 'activesupport'
+  gem.add_dependency 'faraday'
+  gem.add_dependency 'hashie'
+  gem.add_dependency 'faraday_middleware'
+end

data/lib/fulcrum.rb

@@ -0,0 +1,13 @@
+require "fulcrum/version"
+require "fulcrum/api"
+require "fulcrum/form"
+require "fulcrum/record"
+require "fulcrum/choice_list"
+require "fulcrum/classification_set"
+require "fulcrum/member"
+require "fulcrum/photo"
+require "fulcrum/validators/base_validator"
+require "fulcrum/validators/form_validator"
+require "fulcrum/validators/record_validator"
+require "fulcrum/validators/choice_list_validator"
+require "fulcrum/validators/classification_set_validator"

data/lib/fulcrum/api.rb

@@ -0,0 +1,95 @@
+require 'faraday'
+require 'faraday_middleware'
+
+module Fulcrum
+
+  class ApiError < Faraday::Error::ClientError; end
+  class ConnectionError < StandardError; end
+
+  class Api
+
+    VALID_METHODS = [:get, :post, :put, :delete]
+
+    attr :connection
+    attr :response
+    attr_writer :configuration
+
+    class << self
+
+      def key
+        @configuration.key
+      end
+
+      def uri
+        @configuration.uri
+      end
+
+      def response
+        @response
+      end
+
+      def parse_opts(keys = [], opts = {})
+        opts = opts.with_indifferent_access
+        {}.tap do |p|
+          keys.each { |key| p[key.to_sym] = opts[key] if opts.has_key?(key) }
+        end
+      end
+
+      def call(method = :get, path = '', params = {})
+        raise ArgumentError, "Invalid method: #{method.to_s}" unless VALID_METHODS.include?(method.to_sym)
+        @response = connection.send(method.to_sym, path, params)
+        @response.body
+      rescue Faraday::Error::ClientError => e
+        @response = e.response
+        { error: { status: @response[:status], message: @response[:body] } }
+      end
+
+      def configure
+        yield(configuration)
+      end
+
+      def configuration
+        @configuration ||= Configuration.new
+      end
+
+      def connection
+        if !@connection
+          @connection = Faraday.new(Fulcrum::Api.configuration.uri) do |b|
+            b.request  :multipart
+            b.request  :json
+            b.response :raise_error
+            b.response :json , :content_type => 'application/json'
+            b.adapter  Faraday.default_adapter
+          end
+          @connection.headers['X-ApiToken'] = Fulcrum::Api.configuration.key
+          @connection.headers['User-Agent'] = "Ruby Fulcrum API Client, Version #{Fulcrum::VERSION}"
+        end
+        @connection
+      end
+
+      def get_key(username, password)
+        conn = Faraday.new(uri) do |b|
+          b.request  :url_encoded
+          b.response :raise_error
+          b.response :json, :content_type => "application/json"
+          b.adapter Faraday.default_adapter
+        end
+
+        conn.headers['User-Agent'] = "Ruby Fulcrum API Client version #{Fulcrum::VERSION}"
+        conn.basic_auth(username, password)
+        resp = conn.get('users.json')
+        body = JSON.parse(resp.body)
+        if body['user']
+          body['user']['api_token']
+        else
+          nil
+        end
+      end
+    end
+
+    class Configuration
+      attr_accessor :uri
+      attr_accessor :key
+    end
+  end
+end

data/lib/fulcrum/choice_list.rb

@@ -0,0 +1,38 @@
+module Fulcrum
+  class ChoiceList < Api
+
+    class << self
+
+      def all(opts = {})
+        params = parse_opts([:page], opts)
+        call(:get, 'choice_lists.json', params)
+      end
+
+      def find(id)
+        call(:get, "choice_lists/#{id}.json")
+      end
+
+      def create(choice_list)
+        validation = ChoiceListValidator.new(choice_list)
+        if validation.valid?
+          call(:post, 'choice_lists.json', choice_list)
+        else
+          { error: { validation: validation.errors } }
+        end
+      end
+
+      def update(id, choice_list)
+        validation = ChoiceListValidator.new(choice_list)
+        if validation.valid?
+          call(:put, "choice_lists/#{id}.json", choice_list)
+        else
+          { error: { validation: validation.errors } }
+        end
+      end
+
+      def delete(id)
+        call(:delete, "choice_lists/#{id}.json")
+      end
+    end
+  end
+end

data/lib/fulcrum/classification_set.rb

@@ -0,0 +1,39 @@
+module Fulcrum
+  class ClassificationSet < Api
+
+    class << self
+
+      def all(opts = {})
+        params = parse_opts([:page], opts)
+        call(:get, 'classification_sets.json', params)
+      end
+
+      def find(id)
+        call(:get, "classification_sets/#{id}.json")
+      end
+
+      def create(classification_set)
+        validation = ClassificationSetValidator.new(classification_set)
+        if validation.valid?
+          call(:post, 'classification_sets.json', classification_set)
+        else
+          { error: { validation: validation.errors } }
+        end
+      end
+
+      def update(id, classification_set)
+        validation = ClassificationSetValidator.new(classification_set)
+        if validation.valid?
+          call(:put, "classification_sets/#{id}.json", classification_set)
+        else
+          { error: { validation: validation.errors } }
+        end
+      end
+
+      def delete(id)
+        call(:delete, "classification_sets/#{id}.json")
+      end
+    end
+
+  end
+end

data/lib/fulcrum/form.rb

@@ -0,0 +1,39 @@
+module Fulcrum
+  class Form < Api
+
+    class << self
+
+      def all(opts = {})
+        params = self.parse_opts([:page, :schema], opts)
+        self.call(:get, 'forms.json', params)
+      end
+
+      def find(id, opts = {})
+        params = parse_opts([:include_foreign_elements], opts)
+        call(:get, "forms/#{id}.json", params)
+      end
+
+      def create(form)
+        validation = FormValidator.new(form)
+        if validation.valid?
+          call(:post, "forms.json", form)
+        else
+          { error: { validation: validation.errors } }
+        end
+      end
+
+      def update(id, form)
+        validation = FormValidator.new(form)
+        if validation.valid?
+          call(:put, "forms/#{id}.json", form)
+        else
+          { error: { validation: validation.errors } }
+        end
+      end
+
+      def delete(id)
+        call(:delete, "forms/#{id}.json")
+      end
+    end
+  end
+end