fulcrum 0.1.6 → 0.2.0

data/spec/spec_helper.rb

@@ -2,4 +2,6 @@ require 'rspec'
 require 'webmock/rspec'
 require 'fulcrum'
 require 'debugger'
+require 'client_helper'
+require 'resource_examples'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fulcrum
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.2.0
 platform: ruby
 authors:
 - Spatial Networks
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-11 00:00:00.000000000 Z
+date: 2014-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -86,28 +86,14 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.8.8
+        version: 0.9.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.8.8
-- !ruby/object:Gem::Dependency
-  name: hashie
-  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'
+        version: 0.9.0
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
@@ -130,41 +116,49 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
-- .rvmrc
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
 - fulcrum.gemspec
 - lib/fulcrum.rb
-- lib/fulcrum/api.rb
+- lib/fulcrum/actions/create.rb
+- lib/fulcrum/actions/delete.rb
+- lib/fulcrum/actions/find.rb
+- lib/fulcrum/actions/list.rb
+- lib/fulcrum/actions/update.rb
+- lib/fulcrum/changeset.rb
 - lib/fulcrum/choice_list.rb
 - lib/fulcrum/classification_set.rb
+- lib/fulcrum/client.rb
 - lib/fulcrum/form.rb
-- lib/fulcrum/member.rb
+- lib/fulcrum/layer.rb
+- lib/fulcrum/media_resource.rb
+- lib/fulcrum/membership.rb
+- lib/fulcrum/page.rb
 - lib/fulcrum/photo.rb
 - lib/fulcrum/project.rb
 - lib/fulcrum/record.rb
-- lib/fulcrum/validators/base_validator.rb
-- lib/fulcrum/validators/choice_list_validator.rb
-- lib/fulcrum/validators/classification_set_validator.rb
-- lib/fulcrum/validators/form_validator.rb
-- lib/fulcrum/validators/record_validator.rb
+- lib/fulcrum/resource.rb
+- lib/fulcrum/signature.rb
 - lib/fulcrum/version.rb
-- spec/data/form_data.json
+- lib/fulcrum/video.rb
+- spec/client_helper.rb
 - spec/data/test.jpg
-- spec/lib/api_spec.rb
+- spec/data/test.mp4
+- spec/data/test.png
 - spec/lib/choice_list_spec.rb
 - spec/lib/classification_set_spec.rb
+- spec/lib/client_spec.rb
 - spec/lib/form_spec.rb
-- spec/lib/member_spec.rb
+- spec/lib/layer_spec.rb
+- spec/lib/membership_spec.rb
 - spec/lib/photo_spec.rb
 - spec/lib/project_spec.rb
 - spec/lib/record_spec.rb
-- spec/lib/validators/choice_list_validator_spec.rb
-- spec/lib/validators/classification_set_validator_spec.rb
-- spec/lib/validators/form_validator_spec.rb
-- spec/lib/validators/record_validator_spec.rb
+- spec/lib/signature_spec.rb
+- spec/lib/video_spec.rb
+- spec/resource_examples.rb
 - spec/spec_helper.rb
 homepage: http://github.com/spatialnetworks/fulcrum-ruby
 licenses: []
@@ -188,21 +182,23 @@ rubyforge_project:
 rubygems_version: 2.1.5
 signing_key: 
 specification_version: 4
-summary: Fulcrum API
+summary: Fulcrum API client for ruby
 test_files:
-- spec/data/form_data.json
+- spec/client_helper.rb
 - spec/data/test.jpg
-- spec/lib/api_spec.rb
+- spec/data/test.mp4
+- spec/data/test.png
 - spec/lib/choice_list_spec.rb
 - spec/lib/classification_set_spec.rb
+- spec/lib/client_spec.rb
 - spec/lib/form_spec.rb
-- spec/lib/member_spec.rb
+- spec/lib/layer_spec.rb
+- spec/lib/membership_spec.rb
 - spec/lib/photo_spec.rb
 - spec/lib/project_spec.rb
 - spec/lib/record_spec.rb
-- spec/lib/validators/choice_list_validator_spec.rb
-- spec/lib/validators/classification_set_validator_spec.rb
-- spec/lib/validators/form_validator_spec.rb
-- spec/lib/validators/record_validator_spec.rb
+- spec/lib/signature_spec.rb
+- spec/lib/video_spec.rb
+- spec/resource_examples.rb
 - spec/spec_helper.rb
 has_rdoc: 

data/.rvmrc

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

data/lib/fulcrum/api.rb

@@ -1,99 +0,0 @@
-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
-
-      def initialize
-        self.uri = 'https://api.fulcrumapp.com/api/v2'
-      end
-    end
-  end
-end

data/lib/fulcrum/member.rb

@@ -1,16 +0,0 @@
-module Fulcrum
-  class Member < Api
-
-    class << self
-
-      def all(opts = {})
-        params = parse_opts([:page], opts)
-        call(:get, 'members.json', params)
-      end
-
-      def find(id)
-        call(:get, "members/#{id}.json")
-      end
-    end
-  end
-end

data/lib/fulcrum/validators/base_validator.rb

@@ -1,31 +0,0 @@
-require 'active_support/core_ext/hash'
-
-module Fulcrum
-  class BaseValidator
-    attr_accessor :data
-    attr_accessor :errors
-
-    def initialize(data)
-      @data = (data.is_a?(Hash) ? data : JSON.parse(data)).with_indifferent_access
-      @errors = {}
-      validate!
-    end
-
-    def valid?
-      errors.empty?
-    end
-
-    def add_error(key, data_name, error)
-      if errors.has_key?(key)
-        if errors[key].has_key?(data_name)
-          errors[key][data_name].push(error)
-        else
-          errors[key][data_name] = [error]
-        end
-      else
-        errors[key] = {}
-        errors[key][data_name] = [error]
-      end
-    end
-  end
-end

data/lib/fulcrum/validators/choice_list_validator.rb

@@ -1,30 +0,0 @@
-module Fulcrum
-  class ChoiceListValidator < BaseValidator
-
-    def validate!
-      if data['choice_list'].kind_of?(Hash) && !data['choice_list'].blank?
-        add_error('choice_list', 'name', 'must not be blank') if data['choice_list']['name'].blank?
-        choices(data['choice_list']['choices'])
-      else
-        @errors['choice_list'] = ['must be a non-empty hash']
-      end
-      return valid?
-    end
-    
-    def choices(elements)
-      if elements.kind_of?(Array) && !elements.empty?
-        elements.each do |choice|
-          if choice.blank?
-            add_error('choices', 'choice', 'cannot be empty')
-          else
-            if choice['label'].blank?
-              add_error('choice', 'label', 'is required')
-            end
-          end
-        end
-      else
-        add_error('choice_list', 'choices', 'must be a non-empty array')
-      end
-    end
-  end
-end

data/lib/fulcrum/validators/classification_set_validator.rb

@@ -1,38 +0,0 @@
-module Fulcrum
-  class ClassificationSetValidator < BaseValidator
-
-    def validate!
-      if data['classification_set']
-        add_error('classification_set', 'name', 'cannot be blank') if data['classification_set']['name'].blank?
-
-        if data['classification_set']['items'].blank? || !data['classification_set']['items'].kind_of?(Array)
-          add_error('classification_set', 'items', 'must be a non-empty array')
-        else
-          items(data['classification_set']['items'])
-        end
-      else
-        @errors['classification_set'] = ['must exist and not be blank']
-      end
-      return valid?
-    end
-    
-    def items(elements, child = false)
-      parent, child = child ? ['child_classification', 'item'] : ['items', 'item']
-      if elements.kind_of?(Array) && !elements.empty?
-        elements.each do |element|
-          if element.blank?
-            add_error(parent, child, 'cannot be empty')
-          else
-            if element['label'].blank?
-              add_error(child, 'label', 'is required')
-            end
-          end
-          items(element['child_classifications'], true) if element.has_key?('child_classifications')
-        end
-      else
-        add_error(parent, child, 'must be a non-empty array')
-      end
-    end
-  end
-end
-

data/lib/fulcrum/validators/form_validator.rb

@@ -1,150 +0,0 @@
-module Fulcrum
-  class FormValidator < BaseValidator
-
-    TYPES = %w(
-      TextField
-      ChoiceField
-      ClassificationField
-      PhotoField
-      DateTimeField
-      Section
-    )
-
-    def form_elements
-      data['form']['elements']
-    end
-
-    def form_name
-      data['form']['name']
-    end
-
-    def validate!
-      @items  = {}
-      if data[:form]
-        if form_elements && !form_elements.empty?
-          add_error('form', 'name', 'cannot be blank') if data[:form][:name].blank?
-          fields(form_elements)
-          conditionals(form_elements)
-        else
-          add_error('form', 'elements', 'must be a non-empty array')
-        end
-      else
-        @errors['form'] = ['must exist and not be empty']
-      end
-      return valid?
-    end
-
-    def fields(elements)
-      if elements.kind_of?(Array) && !elements.empty?
-        elements.each { |element| field(element) }
-      else
-        add_error('form', 'elements', 'must be a non-empty array')
-      end
-    end
-
-    def field(element)
-      if element.blank?
-        add_error('elements', 'element', 'must not be empty')
-      else
-        if !element[:key]
-          add_error('element', 'key', 'must exist and not be nil')
-          return false
-        end
-
-        if @items.include?(element[:key])
-          add_error(element[:key], :key, 'must be unique')
-          return false
-        end
-
-        key = element[:key]
-        @items[key] = element[:type]
-
-        add_error(key, 'label', 'is required') if element[:label].blank?
-        add_error(key, 'data_name', 'is required') if element[:data_name].blank?
-        add_error(key, 'type', 'is not one of the valid types') unless TYPES.include?(element[:type])
-
-        %w(disabled hidden required).each do |attrib|
-          add_error(key, attrib, 'must be true or false') unless [true, false].include?(element[attrib])
-        end
-
-        case element[:type]
-
-        when 'ClassificationField'
-          if element[:classification_set_id]
-            add_error(key, 'classification_set_id', 'is required') if element[:classification_set_id].blank?
-          end
-
-        when 'Section'
-          if element['elements'].is_a?(Array)
-            if element['elements'].any?
-              fields(element['elements'])
-            else
-              add_error(key, 'elements', 'must contain additional elements')
-            end
-          else
-            add_error(key, 'elements', 'must be an array object')
-          end
-
-        when 'ChoiceField'
-          if element['choice_list_id']
-            add_error(key, 'choice_list_id', 'is required') if element[:choice_list_id].blank?
-          else
-            if element['choices'].is_a?(Array) && !element['choices'].blank?
-              element['choices'].each do |choice|
-                unless choice.has_key?('label') && choice['label'].present?
-                  add_error('choices', 'label', 'contains an invalid label')
-                end
-              end
-            else
-              add_error(key, 'choices', 'must be a non-empty array')
-            end
-          end
-        end
-      end
-    end
-
-    def conditionals(elements)
-      elements.each { |element| conditional(element) }
-    end
-
-    def conditional(element)
-
-      operators = case element[:type]
-      when 'ChoiceField', 'ClassificationField'
-        %w(equal_to not_equal_to is_empty is_not_empty)
-      else
-        %w(equal_to not_equal_to contains starts_with greater_than less_than is_empty is_not_empty)
-      end
-
-      %w(required_conditions visible_conditions).each do |field|
-
-        if type = element["#{field}_type"]
-          add_error(key, "#{field}_type", 'is not valid') unless %(any all).include?(type)
-        end
-
-        if element[field]
-          if element[field].is_a?(Array)
-            element[field].each do |condition|
-
-              if key = condition[:field_key]
-                add_error(key, field, "key #{key} does not exist on the form") unless @items.keys.include?(key)
-                add_error(key, field, "operator for #{key} is invalid") unless operators.include?(condition[:operator])
-
-                if %w(is_empty is_not_empty).include?(condition[:operator]) && condition[:value].present?
-                  add_error(key, field, 'value cannot be blank')
-                end
-              else
-                add_error(key, field, 'field key must exist for condition')
-              end
-
-            end
-          else
-            add_error(key, field, 'must be an array object')
-          end
-        end
-      end
-
-      conditionals(element[:elements]) if element[:type] == 'Section'
-    end
-  end
-end