fulcrum 0.4.2 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f0b25d12d45de68b0476ef5a41955033412541f1
-  data.tar.gz: 1ee80ca2b26ecb1e4d4986d663bd7e460170d925
+  metadata.gz: 8781944fbaa6083aed3dc664491ea0b4d64aa81a
+  data.tar.gz: 7db587061a1f99f651c0702c9bb7fcad8f2569c8
 SHA512:
-  metadata.gz: a7758a23b6aa84420af50c7dc3194e4977b0642ed2874ff04b98568227cfbe92c33d388beff0730826ec12b910afda4a865d94e44edfd3bc42fe82d2e31f895e
-  data.tar.gz: 4b8c17da9d99ce4083ecf443944edfcaf849f8503d1068285fd22101413cda89f649db0b101e5a85321a4260eab4528e7796e8f1db11e0c273a2ebe90307214c
+  metadata.gz: c301bc6dc485899042c3a5d907a50d294ea0c4d35f79c14c04c6b146e8b09907cbba1dde06fb0499988c10cb017a12e3478194a081506f81c7643684f648667c
+  data.tar.gz: 7e165b566ed6c682f5e65d35573e9b732db681e3b657342d17ca6c3291dd671154260ada9c9226d97d5fe70e3edc03c8cca3d20aec10b6e8bbaff114c4c3b37a

data/.travis.yml

@@ -3,3 +3,4 @@ rvm:
   - 1.9.3
   - 2.0.0
   - 2.1.1
+  - 2.2.1

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## v0.5.0
+* Add audio support (#5)
+* Fix broken specs and deprecations (#2)
+* Specify dependency versions in gemspec (#7)
+* Raise exception when media file can't be downloaded (#9)
+
 ## v0.4.2 (October 23, 2014)
 * Fix specs
 * Remove ruby 1.9.2 from travis configuration

data/README.md

@@ -1,10 +1,11 @@
-# Fulcrum [![Build Status](https://secure.travis-ci.org/fulcrumapp/fulcrum-ruby.png)](http://travis-ci.org/fulcrumapp/fulcrum-ruby)
+# Fulcrum [![Build Status](https://secure.travis-ci.org/fulcrumapp/fulcrum-ruby.svg)](http://travis-ci.org/fulcrumapp/fulcrum-ruby) [![Gem Version](https://badge.fury.io/rb/fulcrum.svg)](http://badge.fury.io/rb/fulcrum)
+
 
 Fulcrum API Gem
 
 ## Requirements
 
-* Ruby 1.9
+* Ruby 1.9.3+
 * [Fulcrum account](https://web.fulcrumapp.com)
 
 ## Installation
@@ -235,6 +236,37 @@ Fetches the GPS track for the specified video.
 
 
 
+## Audio
+
+### client.audio.all(params = {})
+
+### client.audio.find(id)
+
+### client.audio.create(file_or_path, content_type = 'audio/x-m4a', attributes = {})
+
+Create a new audio object from a file or a file path. `attributes` must be a `Hash` and currently only accepts 2 attributes, `access_key` and `track`.
+If you specify an `access_key`, it must be a UUID. If you don't specify an `access_key`, one will be automatically generated and returned in the response.
+
+### client.audio.delete(id)
+
+### client.audio.original(id) {|io| block }
+
+Downloads the original version and yields an IO object to the block.
+
+### client.audio.small(id) {|io| block }
+
+Downloads the small version and yields an IO object to the block.
+
+### client.audio.medium(id) {|io| block }
+
+Downloads the medium version and yields an IO object to the block.
+
+### client.audio.track(id)
+
+Fetches the GPS track for the specified audio.
+
+
+
 ## Memberships
 
 ### client.memberships.all(params = {})
@@ -254,6 +286,7 @@ Fetches the GPS track for the specified video.
 ### client.changesets.close(id, changeset = {})
 
 
+
 ## Webhooks
 
 ### client.webhooks.all(params = {})
@@ -267,6 +300,7 @@ Fetches the GPS track for the specified video.
 ### client.webhooks.delete(id)
 
 
+
 ## Extra Reading
 
 * [Fulcrum API documentation](http://fulcrumapp.com/developers/api/)

data/fulcrum.gemspec

@@ -16,11 +16,11 @@ Gem::Specification.new do |gem|
   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 'rake', '~> 10.4', '>= 10.4.2'
+  gem.add_development_dependency 'rspec', '~> 3.2', '>= 3.2.0'
+  gem.add_development_dependency 'webmock', '~> 1.12', '>= 1.12.0'
 
-  gem.add_dependency 'activesupport'
-  gem.add_dependency 'faraday', '~> 0.9.0'
-  gem.add_dependency 'faraday_middleware'
+  gem.add_dependency 'activesupport', '~> 4.2', '>= 4.2.1'
+  gem.add_dependency 'faraday', '~> 0.9', '>= 0.9.1'
+  gem.add_dependency 'faraday_middleware', '~> 0.9', '>= 0.9.1'
 end

data/lib/fulcrum.rb

@@ -14,6 +14,7 @@ require 'fulcrum/form'
 require 'fulcrum/membership'
 require 'fulcrum/photo'
 require 'fulcrum/video'
+require 'fulcrum/audio'
 require 'fulcrum/signature'
 require 'fulcrum/project'
 require 'fulcrum/record'

data/lib/fulcrum/audio.rb

@@ -0,0 +1,27 @@
+module Fulcrum
+  class Audio < MediaResource
+    def resources_name
+      resource_name
+    end
+
+    def default_content_type
+      'audio/x-m4a'
+    end
+
+    def create_action
+      'audio/upload'
+    end
+
+    def small(id, &blk)
+      download_version(id, 'small', &blk)
+    end
+
+    def medium(id, &blk)
+      download_version(id, 'medium', &blk)
+    end
+
+    def track(id)
+      call(:get, member_action(id, 'track'))
+    end
+  end
+end

data/lib/fulcrum/client.rb

@@ -93,6 +93,10 @@ module Fulcrum
       @videos ||= Fulcrum::Video.new(self)
     end
 
+    def audio
+      @audio ||= Fulcrum::Audio.new(self)
+    end
+
     def signatures
       @signatures ||= Fulcrum::Signature.new(self)
     end

data/lib/fulcrum/media_resource.rb

@@ -6,6 +6,8 @@ module Fulcrum
     include Actions::Find
     include Actions::Create
 
+    class Fulcrum::MediaNotAvailableError < StandardError; end
+
     def default_content_type
       raise NotImplementedError,
         'default_content_type must be implemented in derived classes'
@@ -33,7 +35,13 @@ module Fulcrum
     end
 
     def download_version(access_key, version, &blk)
-      download(find(access_key)[version], &blk)
+      media = find(access_key)
+
+      unless media[version]
+        raise Fulcrum::MediaNotAvailableError, "The #{resource_name} version you requested is not available."
+      end
+
+      download(media[version], &blk)
     end
 
     def original(access_key, &blk)

data/lib/fulcrum/version.rb

@@ -1,3 +1,3 @@
 module Fulcrum
-  VERSION = "0.4.2"
+  VERSION = "0.5.0"
 end

data/spec/lib/audio_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+include Support::ResourceExamples
+
+describe Fulcrum::Audio do
+  let(:test_file) { './spec/data/test.m4a' }
+
+  include_context 'with client'
+  include_context 'with media resource'
+
+  let(:resource) { client.audio }
+
+  include_examples 'lists resource'
+  include_examples 'finds resource'
+  include_examples 'creates resource'
+end

data/spec/lib/choice_list_spec.rb

@@ -8,9 +8,9 @@ describe Fulcrum::ChoiceList do
 
   let(:resource) { client.choice_lists }
 
-  include_examples 'list resource'
-  include_examples 'find resource'
-  include_examples 'create resource'
-  include_examples 'update resource'
-  include_examples 'delete resource'
+  include_examples 'lists resource'
+  include_examples 'finds resource'
+  include_examples 'creates resource'
+  include_examples 'updates resource'
+  include_examples 'deletes resource'
 end

data/spec/lib/classification_set_spec.rb

@@ -8,10 +8,10 @@ describe Fulcrum::ClassificationSet do
 
   let(:resource) { client.classification_sets }
 
-  include_examples 'list resource'
-  include_examples 'find resource'
-  include_examples 'create resource'
-  include_examples 'update resource'
-  include_examples 'delete resource'
+  include_examples 'lists resource'
+  include_examples 'finds resource'
+  include_examples 'creates resource'
+  include_examples 'updates resource'
+  include_examples 'deletes resource'
 end
 

data/spec/lib/client_spec.rb

@@ -4,6 +4,6 @@ describe Fulcrum::Client do
   let(:client) { Fulcrum::Client.new }
 
   it 'has a default url' do
-    client.url.should eq(Fulcrum::Client::DEFAULT_URL)
+    expect(client.url).to eq(Fulcrum::Client::DEFAULT_URL)
   end
 end

data/spec/lib/form_spec.rb

@@ -8,9 +8,9 @@ describe Fulcrum::Form do
 
   let(:resource) { client.forms }
 
-  include_examples 'list resource'
-  include_examples 'find resource'
-  include_examples 'create resource'
-  include_examples 'update resource'
-  include_examples 'delete resource'
+  include_examples 'lists resource'
+  include_examples 'finds resource'
+  include_examples 'creates resource'
+  include_examples 'updates resource'
+  include_examples 'deletes resource'
 end

data/spec/lib/layer_spec.rb

@@ -8,6 +8,6 @@ describe Fulcrum::Layer do
 
   let(:resource) { client.layers }
 
-  include_examples 'list resource'
-  include_examples 'find resource'
+  include_examples 'lists resource'
+  include_examples 'finds resource'
 end

data/spec/lib/membership_spec.rb

@@ -8,5 +8,5 @@ describe Fulcrum::Membership do
 
   let(:resource) { client.memberships }
 
-  include_examples 'list resource'
+  include_examples 'lists resource'
 end

data/spec/lib/photo_spec.rb

@@ -10,7 +10,7 @@ describe Fulcrum::Photo do
 
   let(:resource) { client.photos }
 
-  include_examples 'list resource'
-  include_examples 'find resource'
-  include_examples 'create resource'
+  include_examples 'lists resource'
+  include_examples 'finds resource'
+  include_examples 'creates resource'
 end

data/spec/lib/project_spec.rb

@@ -8,6 +8,6 @@ describe Fulcrum::Project do
 
   let(:resource) { client.projects }
 
-  include_examples 'list resource'
-  include_examples 'find resource'
+  include_examples 'lists resource'
+  include_examples 'finds resource'
 end

data/spec/lib/record_spec.rb

@@ -8,9 +8,9 @@ describe Fulcrum::Record do
 
   let(:resource) { client.records }
 
-  include_examples 'list resource'
-  include_examples 'find resource'
-  include_examples 'create resource'
-  include_examples 'update resource'
-  include_examples 'delete resource'
+  include_examples 'lists resource'
+  include_examples 'finds resource'
+  include_examples 'creates resource'
+  include_examples 'updates resource'
+  include_examples 'deletes resource'
 end

data/spec/lib/signature_spec.rb

@@ -10,7 +10,7 @@ describe Fulcrum::Signature do
 
   let(:resource) { client.signatures }
 
-  include_examples 'list resource'
-  include_examples 'find resource'
-  include_examples 'create resource'
+  include_examples 'lists resource'
+  include_examples 'finds resource'
+  include_examples 'creates resource'
 end

data/spec/lib/video_spec.rb

@@ -10,7 +10,7 @@ describe Fulcrum::Video do
 
   let(:resource) { client.videos }
 
-  include_examples 'list resource'
-  include_examples 'find resource'
-  include_examples 'create resource'
+  include_examples 'lists resource'
+  include_examples 'finds resource'
+  include_examples 'creates resource'
 end

data/spec/lib/webhook_spec.rb

@@ -8,9 +8,9 @@ describe Fulcrum::Webhook do
 
   let(:resource) { client.webhooks }
 
-  include_examples 'list resource'
-  include_examples 'find resource'
-  include_examples 'create resource'
-  include_examples 'update resource'
-  include_examples 'delete resource'
+  include_examples 'lists resource'
+  include_examples 'finds resource'
+  include_examples 'creates resource'
+  include_examples 'updates resource'
+  include_examples 'deletes resource'
 end

data/spec/resource_examples.rb

@@ -38,11 +38,11 @@ module Support
       let(:show_response) do
         data = {}
         data[resource_name] = resource_object
-        data.as_json
+        data.to_json
       end
     end
 
-    shared_examples 'list resource' do
+    shared_examples 'lists resource' do
       include_context 'with client'
       include_context 'with resource parameters'
 
@@ -56,43 +56,45 @@ module Support
       let(:list_response) do
         data = pagination
         data[resource.resources_name.to_sym] = []
-        data.as_json
+        data.to_json
       end
 
-      it 'should list all resources' do
+      it 'lists all resources' do
         stub_request(:get, collection_url)
-          .to_return(status: 200, body: list_response)
+          .to_return(status: 200, body: list_response,
+                     headers: {"Content-Type" => "application/json"})
 
         page = resource.all
 
-        client.response.status.should eq(200)
+        expect(client.response.status).to eq(200)
 
-        page.should respond_to(:current_page)
-        page.should respond_to(:total_pages)
-        page.should respond_to(:total_count)
-        page.should respond_to(:per_page)
+        expect(page).to respond_to(:current_page)
+        expect(page).to respond_to(:total_pages)
+        expect(page).to respond_to(:total_count)
+        expect(page).to respond_to(:per_page)
 
-        page.objects.should be_a(Array)
+        expect(page.objects).to be_a(Array)
       end
     end
 
-    shared_examples 'find resource' do
+    shared_examples 'finds resource' do
       include_context 'with client'
       include_context 'with resource parameters'
 
-      it 'should find a resource' do
+      it 'finds a resource' do
         stub_request(:get, member_url)
-          .to_return(status: 200, body: show_response)
+          .to_return(status: 200, body: show_response,
+                     headers: {"Content-Type" => "application/json"})
 
         object = resource.find(resource_id)
 
-        client.response.status.should eq(200)
+        expect(client.response.status).to eq(200)
 
-        object.should be_a(Hash)
+        expect(object).to be_a(Hash)
       end
     end
 
-    shared_examples 'create resource' do
+    shared_examples 'creates resource' do
       include_context 'with client'
       include_context 'with resource parameters'
 
@@ -100,47 +102,50 @@ module Support
         "#{client.url}/#{resource.create_action}"
       end
 
-      it 'should create a new resource' do
+      it 'creates a new resource' do
         stub_request(:post, create_url)
-          .to_return(status: 201, body: show_response)
+          .to_return(status: 201, body: show_response,
+                     headers: {"Content-Type" => "application/json"})
 
         object = resource.create(*create_parameters)
 
-        client.response.status.should eq(201)
+        expect(client.response.status).to eq(201)
 
-        object.should be_a(Hash)
+        expect(object).to be_a(Hash)
       end
     end
 
-    shared_examples 'update resource' do
+    shared_examples 'updates resource' do
       include_context 'with client'
       include_context 'with resource parameters'
 
-      it 'should update a resource' do
+      it 'updates a resource' do
         stub_request(:put, member_url)
-          .to_return(status: 200, body: show_response)
+          .to_return(status: 200, body: show_response,
+                     headers: {"Content-Type" => "application/json"})
 
         object = resource.update(resource_id, resource_object)
 
-        client.response.status.should eq(200)
+        expect(client.response.status).to eq(200)
 
-        object.should be_a(Hash)
+        expect(object).to be_a(Hash)
       end
     end
 
-    shared_examples 'delete resource' do
+    shared_examples 'deletes resource' do
       include_context 'with client'
       include_context 'with resource parameters'
 
-      it 'should delete a resource' do
+      it 'deletes a resource' do
         stub_request(:delete, member_url)
-          .to_return(status: 204, body: show_response)
+          .to_return(status: 204, body: show_response,
+                     headers: {"Content-Type" => "application/json"})
 
         object = resource.delete(resource_id)
 
-        client.response.status.should eq(204)
+        expect(client.response.status).to eq(204)
 
-        object.should be_a(Hash)
+        expect(object).to be_a(Hash)
       end
     end
   end

metadata

@@ -1,99 +1,135 @@
 --- !ruby/object:Gem::Specification
 name: fulcrum
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.5.0
 platform: ruby
 authors:
 - Fulcrum
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-23 00:00:00.000000000 Z
+date: 2015-04-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 10.4.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 10.4.2
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.2.0
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.12.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.12.0
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 4.2.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 4.2.1
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: '0.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: '0.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.1
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.9.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.9.1
 description: Fulcrum API
 email:
 - info@fulcrumapp.com
@@ -115,6 +151,7 @@ files:
 - lib/fulcrum/actions/find.rb
 - lib/fulcrum/actions/list.rb
 - lib/fulcrum/actions/update.rb
+- lib/fulcrum/audio.rb
 - lib/fulcrum/changeset.rb
 - lib/fulcrum/choice_list.rb
 - lib/fulcrum/classification_set.rb
@@ -134,8 +171,10 @@ files:
 - lib/fulcrum/webhook.rb
 - spec/client_helper.rb
 - spec/data/test.jpg
+- spec/data/test.m4a
 - spec/data/test.mp4
 - spec/data/test.png
+- spec/lib/audio_spec.rb
 - spec/lib/choice_list_spec.rb
 - spec/lib/classification_set_spec.rb
 - spec/lib/client_spec.rb
@@ -170,15 +209,17 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Fulcrum API client for ruby
 test_files:
 - spec/client_helper.rb
 - spec/data/test.jpg
+- spec/data/test.m4a
 - spec/data/test.mp4
 - spec/data/test.png
+- spec/lib/audio_spec.rb
 - spec/lib/choice_list_spec.rb
 - spec/lib/classification_set_spec.rb
 - spec/lib/client_spec.rb
@@ -193,3 +234,4 @@ test_files:
 - spec/lib/webhook_spec.rb
 - spec/resource_examples.rb
 - spec/spec_helper.rb
+has_rdoc: