fulcrum 0.1.6 → 0.2.0

data/lib/fulcrum/actions/find.rb

@@ -0,0 +1,11 @@
+module Fulcrum
+  module Actions
+    module Find
+      extend ActiveSupport::Concern
+
+      def find(id)
+        call(:get, member(id))[resource_name]
+      end
+    end
+  end
+end

data/lib/fulcrum/actions/list.rb

@@ -0,0 +1,19 @@
+module Fulcrum
+  module Actions
+    module List
+      DEFAULT_PER_PAGE = 250
+
+      extend ActiveSupport::Concern
+
+      def default_list_params
+        { per_page: DEFAULT_PER_PAGE }
+      end
+
+      def all(params = default_list_params)
+        result = call(:get, collection, default_list_params.merge(params))
+
+        Page.new(result, resources_name)
+      end
+    end
+  end
+end

data/lib/fulcrum/actions/update.rb

@@ -0,0 +1,11 @@
+module Fulcrum
+  module Actions
+    module Update
+      extend ActiveSupport::Concern
+
+      def update(id, object)
+        call(:put, member(id), attributes_for_object(object))[resource_name]
+      end
+    end
+  end
+end

data/lib/fulcrum/changeset.rb

@@ -0,0 +1,12 @@
+module Fulcrum
+  class Changeset < Resource
+    include Actions::List
+    include Actions::Find
+    include Actions::Create
+    include Actions::Update
+
+    def close(id, object={})
+      call(:put, member_action(id, 'close'), attributes_for_object(object))[resource_name]
+    end
+  end
+end

data/lib/fulcrum/choice_list.rb

@@ -1,38 +1,9 @@
 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
+  class ChoiceList < Resource
+    include Actions::List
+    include Actions::Find
+    include Actions::Create
+    include Actions::Update
+    include Actions::Delete
   end
 end

data/lib/fulcrum/classification_set.rb

@@ -1,39 +1,9 @@
 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
-
+  class ClassificationSet < Resource
+    include Actions::List
+    include Actions::Find
+    include Actions::Create
+    include Actions::Update
+    include Actions::Delete
   end
 end

data/lib/fulcrum/client.rb

@@ -0,0 +1,120 @@
+require 'faraday'
+require 'faraday_middleware'
+
+module Fulcrum
+
+  class Client
+
+    DEFAULT_URL = 'https://api.fulcrumapp.com/api/v2'
+
+    DEFAULT_USER_AGENT = "Fulcrum Ruby API Client, Version #{Fulcrum::VERSION}"
+
+    attr_accessor :connection
+    attr_accessor :response
+    attr_accessor :key
+    attr_accessor :url
+
+    def initialize(key = nil, url = nil)
+      self.key = key
+      self.url = url || DEFAULT_URL
+    end
+
+    def key=(key)
+      @key = key
+      reset
+    end
+
+    def url=(url)
+      @url = url
+      reset
+    end
+
+    def reset
+      @response = nil
+      @connection = nil
+    end
+
+    def call(method = :get, path = '', params = {})
+      @response = connection.send(method.to_sym, path, params.with_indifferent_access)
+      @response.body
+    end
+
+    def connection
+      @connection ||= self.class.create_connection(url, key)
+    end
+
+    def self.authenticate(username, password, url=DEFAULT_URL)
+      connection = create_connection(url)
+
+      connection.basic_auth(username, password)
+
+      resp = connection.get('users.json')
+
+      resp.body['user']['contexts'].map do |context|
+        { id: context['id'],
+          name: context['name'],
+          token: context['api_token'] }
+      end
+    end
+
+    def self.create_connection(url, key = nil)
+      Faraday.new(url) do |connection|
+        connection.request  :multipart
+        connection.request  :json
+
+        connection.response :raise_error
+        connection.response :json, content_type: 'application/json'
+
+        connection.adapter  Faraday.default_adapter
+
+        connection.headers['X-ApiToken'] = key if key
+        connection.headers['X-Require-Media'] = 'false'
+        connection.headers['User-Agent'] = DEFAULT_USER_AGENT
+      end
+    end
+
+    def choice_lists
+      @choice_lists ||= Fulcrum::ChoiceList.new(self)
+    end
+
+    def classification_sets
+      @classification_sets ||= Fulcrum::ClassificationSet.new(self)
+    end
+
+    def forms
+      @forms ||= Fulcrum::Form.new(self)
+    end
+
+    def photos
+      @photos ||= Fulcrum::Photo.new(self)
+    end
+
+    def videos
+      @videos ||= Fulcrum::Video.new(self)
+    end
+
+    def signatures
+      @signatures ||= Fulcrum::Signature.new(self)
+    end
+
+    def projects
+      @projects ||= Fulcrum::Project.new(self)
+    end
+
+    def records
+      @records ||= Fulcrum::Record.new(self)
+    end
+
+    def memberships
+      @memberships ||= Fulcrum::Membership.new(self)
+    end
+
+    def layers
+      @layers ||= Fulcrum::Layer.new(self)
+    end
+
+    def changesets
+      @changesets ||= Fulcrum::Changeset.new(self)
+    end
+  end
+end

data/lib/fulcrum/form.rb

@@ -1,38 +1,9 @@
 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
+  class Form < Resource
+    include Actions::List
+    include Actions::Find
+    include Actions::Create
+    include Actions::Update
+    include Actions::Delete
   end
 end

data/lib/fulcrum/layer.rb

@@ -0,0 +1,6 @@
+module Fulcrum
+  class Layer < Resource
+    include Actions::List
+    include Actions::Find
+  end
+end

data/lib/fulcrum/media_resource.rb

@@ -0,0 +1,47 @@
+require 'open-uri'
+
+module Fulcrum
+  class MediaResource < Resource
+    include Actions::List
+    include Actions::Find
+    include Actions::Create
+
+    def default_content_type
+      raise NotImplementedError,
+        'default_content_type must be implemented in derived classes'
+    end
+
+    def attributes_for_upload(file, content_type = nil, attributes = {})
+      attributes ||= {}
+
+      file = Faraday::UploadIO.new(file, content_type || default_content_type)
+
+      attributes[:file] = file
+      attributes[:access_key] ||= new_access_key
+
+      media_attributes = {}
+      media_attributes[resource_name] = attributes
+      media_attributes
+    end
+
+    def create(file, content_type = nil, attrs = {})
+      call(:post, create_action, attributes_for_upload(file, content_type, attrs))
+    end
+
+    def download(url, &blk)
+      open(url, "rb", &blk)
+    end
+
+    def download_version(access_key, version, &blk)
+      download(find(access_key)[version], &blk)
+    end
+
+    def original(access_key, &blk)
+      download_version(access_key, 'original', &blk)
+    end
+
+    def new_access_key
+      SecureRandom.uuid
+    end
+  end
+end

data/lib/fulcrum/membership.rb

@@ -0,0 +1,5 @@
+module Fulcrum
+  class Membership < Resource
+    include Actions::List
+  end
+end

data/lib/fulcrum/page.rb

@@ -0,0 +1,17 @@
+module Fulcrum
+  class Page
+    attr_accessor :objects
+    attr_accessor :current_page
+    attr_accessor :total_pages
+    attr_accessor :total_count
+    attr_accessor :per_page
+
+    def initialize(data, resources_name)
+      self.objects      = data[resources_name]
+      self.current_page = data['current_page']
+      self.total_pages  = data['total_pages']
+      self.total_count  = data['total_count']
+      self.per_page     = data['per_page']
+    end
+  end
+end

data/lib/fulcrum/photo.rb

@@ -1,35 +1,15 @@
 module Fulcrum
-  class Photo < Api
-
-    ALLOWED_FORMATS = %w(jpg json)
-
-    class << self
-
-      def find(id, opts = {})
-        format = image_opts(opts)
-        call(:get, "photos/#{id}.#{format}")
-      end
-
-      def thumbnail(id, opts = {})
-        format = image_opts(opts)
-        call(:get, "photos/#{id}/thumbnail.#{format}")
-      end
-
-      def create(file, content_type, id, label = '')
-        photo = Faraday::UploadIO.new(file, content_type)
-        call(:post, 'photos.json', { photo: { file: photo, access_key: id, label: label}})
-      end
+  class Photo < MediaResource
+    def default_content_type
+      'image/jpeg'
+    end
 
-      def delete(id)
-        call(:delete, "photos/#{id}.json")
-      end
+    def large(id, &blk)
+      download_version(id, 'large', &blk)
+    end
 
-      def image_opts(opts = {})
-        opts = opts.with_indifferent_access
-        format = opts.delete(:format) || 'json'
-        raise ArgumentError, "#{format} is not an allowed format, use either 'json' or 'jpg'" unless ALLOWED_FORMATS.include?(format)
-        format
-      end
+    def thumbnail(id, &blk)
+      download_version(id, 'thumbnail', &blk)
     end
   end
 end