amara 0.0.4 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cb71839ee3ae5733b9a9cf50421a0d8dae793773
-  data.tar.gz: 50244918e66cb0378bae5a1a751aca9fe16f4068
+  metadata.gz: 6cd6ab24e7e99f8366d46abe69365bed8f663837
+  data.tar.gz: 3e79c86e57e157e5a2cf4900bbb2cff53db291d4
 SHA512:
-  metadata.gz: be6217c3aafff5c865fd9a788249a9d3f033b9ce21b204fcff87959437ac24312486cf8903541c8157d3c20f7da01d8f496e30bd1c53881374dfc0707cb581b3
-  data.tar.gz: 4fac54ac1e87d09581392502ec04904a127d7adb81e3bd007c19cbb1782354fd014d8d7c3390db323ebdbce9a42c763c57c42f190556c4e62feb680209091a5d
+  metadata.gz: 3db329af8e80bed9175df220a782f26561788ad499fc77a72e09556ce6a293f52fb009e885645fe8dde0c216600247fb0c8f96fa1a280519757cd02ed077869f
+  data.tar.gz: 632e1937893a11752655146393fc9975a31346f0ed213bb9754841c82fa6db7213f776f89bd68bec4e8f918d6df4903dfefb4720fdf5eb7765f85a153c05ca35

data/README.md

@@ -3,6 +3,7 @@
 Ruby gem to access the Amara API.
 
 http://www.amara.org/
+
 http://amara.readthedocs.org/en/latest/api.html
 
 ## Installation
@@ -24,9 +25,81 @@ Or install it yourself as:
 You need a user account and API key to use the API.
 Some capabilities (e.g. creating a team) are only enabled for enterprise customers.
 
+You can use the API on these top level and nested entities (see the client.rb for top level) that match the APi docs:
+
 ```ruby
-amara = Amara::Client.new(api_username: 'amara_api_username', api_key: 'amara_api_key')
+amara = Amara::Client.new
+
 amara.videos
+amara.videos.languages
+amara.videos.languages.subtitles
+amara.videos.urls
+
+amara.users
+
+amara.teams
+amara.teams.applications
+amara.teams.members
+amara.teams.projects
+amara.teams.safe_members
+amara.teams.tasks
+
+amara.activity
+
+amara.languages
+
+amara.message
+```
+
+For each type of entity, you get the following methods: `list`, `get`, `create`, `update`, and `delete`.
+
+All these method calls return an `Amara::Response` instance.
+
+Entities may be nested, and params passed in for each nesting.
+params to an entity can be a Hash of options, or a string, in which case it is treated like the id of that entity type.
+
+Here is an example of how to get the English subtitles for a video with a certain id.
+It shows the use of nested entities, string id params for each entity, and the get method called with no query params:
+```ruby
+amara = Amara::Client.new(api_username: 'amara_api_username', api_key: 'amara_api_key')
+
+# get the English subtitles for a video
+amara.videos('yourVideoId').languages('en').subtitles.get
+
+```
+
+Here are some more examples of listing and creating a video:
+```ruby
+# get a list of videos
+amara = Amara::Client.new(api_username: 'amara_api_username', api_key: 'amara_api_key')
+response = amara.videos
+videos = response.objects.list
+
+# amara responses for a 'list' are paged, get the next page like this:
+more_videos = response.next_page
+
+
+# create a video
+response = amara.videos.create({
+  team:      'my-team-name',
+  title:     'title',
+  video_url: 'https://archive.org/download/example/example.ogg',
+  primary_audio_language_code: 'en'
+})
+video = response.object
+```
+
+You can do these same operations for Teams and other entities.
+The gem defines lists of `Amara::POLICIES` and `Amara::TEAM_POLICIES` you can use in your requests:
+```ruby
+# create a team
+new_team = amara.teams.create(
+  slug:              'prx-test-1',
+  name:              'prx test 1',
+  is_visible:        false,
+  membership_policy: Amara::TEAM_POLICIES[:invite]
+)
+
 ```
 
 ## Contributing

data/lib/amara/activity.rb

@@ -0,0 +1,6 @@
+# -*- encoding: utf-8 -*-
+
+module Amara
+  class Activity < API
+  end
+end

data/lib/amara/client.rb

@@ -3,6 +3,18 @@
 module Amara
   class Client < API
 
+    def activity(params={}, &block)
+      @activity ||= ApiFactory.api('Amara::Activity', self, params, &block)
+    end
+
+    def languages(params={}, &block)
+      @languages ||= ApiFactory.api('Amara::Languages', self, params, &block)
+    end
+
+    def message(params={}, &block)
+      @message ||= ApiFactory.api('Amara::Message', self, params, &block)
+    end
+
     def teams(params={}, &block)
       @teams ||= ApiFactory.api('Amara::Teams', self, params, &block)
     end
@@ -11,8 +23,8 @@ module Amara
       @videos ||= ApiFactory.api('Amara::Videos', self, params, &block)
     end
 
-    def languages(params={}, &block)
-      @languages ||= ApiFactory.api('Amara::Languages', self, params, &block)
+    def users(params={}, &block)
+      @users ||= ApiFactory.api('Amara::Users', self, params, &block)
     end
 
   end

data/lib/amara/message.rb

@@ -0,0 +1,6 @@
+# -*- encoding: utf-8 -*-
+
+module Amara
+  class Message < API
+  end
+end

data/lib/amara/teams.rb

@@ -3,6 +3,10 @@
 module Amara
   class Teams < API
 
+    def applications(params={}, &block)
+      @applications ||= ApiFactory.api('Amara::Teams::Applications', self, params, &block)
+    end
+
     def members(params={}, &block)
       @members ||= ApiFactory.api('Amara::Teams::Members', self, params, &block)
     end
@@ -15,5 +19,9 @@ module Amara
       @safe_members ||= ApiFactory.api('Amara::Teams::SafeMembers', self, params, &block)
     end
 
+    def tasks(params={}, &block)
+      @tasks ||= ApiFactory.api('Amara::Teams::Tasks', self, params, &block)
+    end
+
   end
 end

data/lib/amara/teams/applications.rb

@@ -0,0 +1,6 @@
+# -*- encoding: utf-8 -*-
+
+module Amara
+  class Teams::Applications < API
+  end
+end

data/lib/amara/teams/tasks.rb

@@ -0,0 +1,6 @@
+# -*- encoding: utf-8 -*-
+
+module Amara
+  class Teams::Tasks < API
+  end
+end

data/lib/amara/users.rb

@@ -0,0 +1,6 @@
+# -*- encoding: utf-8 -*-
+
+module Amara
+  class Users < API
+  end
+end

data/lib/amara/version.rb

@@ -1,5 +1,5 @@
 # -*- encoding: utf-8 -*-
 
 module Amara
-  VERSION = "0.0.4"
+  VERSION = "0.1.0"
 end

data/lib/amara/videos.rb

@@ -8,11 +8,11 @@ module Amara
     VIDEO_LIST_PARAMS   = [:order_by, :project, :team, :video_url]
     VIDEO_ORDERING      = [:created, :title]
 
-    def languages(options={}, &block)
+    def languages(params={}, &block)
       @languages ||= ApiFactory.api('Amara::Videos::Languages', self, params, &block)
     end
 
-    def urls(options={}, &block)
+    def urls(params={}, &block)
       @urls ||= ApiFactory.api('Amara::Videos::Urls', self, params, &block)
     end
 

data/lib/amara/videos/languages.rb

@@ -3,7 +3,7 @@
 module Amara
   class Videos::Languages < API
 
-    def subtitles(options={}, &block)
+    def subtitles(params={}, &block)
       @subtitles ||= ApiFactory.api('Amara::Videos::Languages::Subtitles', self, params, &block)
     end
 

data/test/teams_test.rb

@@ -31,25 +31,36 @@ describe Amara::Teams do
   end
 
   it "returns a team" do
-    response = '{"created": "2013-02-14T07:29:55", "deleted": false, "description": "", "header_html_text": "", "is_moderated": false, "is_visible": true, "logo": null, "max_tasks_per_member": null, "membership_policy": "Open", "name": "", "projects_enabled": false, "resource_uri": "/api2/partners/teams/tedx-import/", "slug": "tedx-import", "subtitle_policy": "Anyone", "task_assign_policy": "Any team member", "task_expiration": null, "translate_policy": "Anyone", "video_policy": "Any team member", "workflow_enabled": false}'
-    stub_request(:get, "https://www.amara.org/api2/partners/teams/tedx-import/").
+    response = '{"created": "2013-02-14T07:29:55", "deleted": false, "description": "", "header_html_text": "", "is_moderated": false, "is_visible": true, "logo": null, "max_tasks_per_member": null, "membership_policy": "Open", "name": "", "projects_enabled": false, "resource_uri": "/api2/partners/teams/tedx-import/", "slug": "prx-test-1", "subtitle_policy": "Anyone", "task_assign_policy": "Any team member", "task_expiration": null, "translate_policy": "Anyone", "video_policy": "Any team member", "workflow_enabled": false}'
+    stub_request(:get, "https://www.amara.org/api2/partners/teams/prx-test-1/").
        to_return(body: response)
 
     teams = Amara::Teams.new(api_key: 'thisisakey', api_username: 'test_user')
 
-    response = teams.get("tedx-import")
+    response = teams.get("prx-test-1")
     response.object.wont_be_nil
     team = response.object
-    team.slug.must_equal 'tedx-import'
+    team.slug.must_equal 'prx-test-1'
 
-    response = teams.get(team_id: "tedx-import")
+    response = teams.get(team_id: "prx-test-1")
     response.object.wont_be_nil
     team = response.object
-    team.slug.must_equal 'tedx-import'
+    team.slug.must_equal 'prx-test-1'
   end
 
   it "created a new team" do
     create_response = '{"created": "2013-08-01T13:11:45.167206", "deleted": false, "description": "", "header_html_text": "", "is_moderated": false, "is_visible": true, "logo": null, "max_tasks_per_member": null, "membership_policy": "Open", "name": "prx test 1", "projects_enabled": false, "resource_uri": "/api2/partners/teams/prx-test-1/", "slug": "prx-test-1", "subtitle_policy": "Anyone", "task_assign_policy": "Any team member", "task_expiration": null, "translate_policy": "Anyone", "video_policy": "Any team member", "workflow_enabled": false}'
+
+    stub_request(:post, "https://www.amara.org/api2/partners/teams/").
+      with(:body => "{\"slug\":\"prx-test-1\",\"name\":\"prx test 1\"}",
+           :headers => {'Accept'=>'application/json', 'Content-Type'=>'application/json', 'Host'=>'www.amara.org:443', 'User-Agent'=>'Amara Ruby Gem 0.1.0', 'X-Api-Username'=>'test_user', 'X-Apikey'=>'thisisakey'}).
+      to_return(:status => 200, :body => create_response, :headers => {})
+    
+
+    teams = Amara::Teams.new(api_key: 'thisisakey', api_username: 'test_user')
+
+    response = teams.create(slug: 'prx-test-1', name: 'prx test 1')
+
   end
 
 end

data/test/videos_test.rb

@@ -0,0 +1,85 @@
+# -*- encoding: utf-8 -*-
+
+require File.expand_path(File.dirname(__FILE__) + '/test_helper')
+
+require 'amara/api'
+require 'amara/videos'
+
+require 'webmock/minitest'
+
+describe Amara::Videos do
+
+  it "gets the base path for this subclass of API" do
+    videos = Amara::Videos.new
+    videos.base_path.must_equal 'videos'
+  end
+
+  it "returns a video" do
+    response = {
+      "all_urls"                    => ["https://archive.org/download/1-test-mp3.JRiaC2.popuparchive.org/test.ogg"],
+      "created"                     => "2013-08-29T15:35:25.518514",
+      "description"                 => "",
+      "duration"                    => nil,
+      "id"                          => "s7TbkyDizi6k",
+      "languages"                   => [],
+      "metadata"                    => {},
+      "original_language"           => "en",
+      "primary_audio_language_code" => "en",
+      "project"                     => nil,
+      "resource_uri"                => "/api2/partners/videos/s7TbkyDizi6k/",
+      "site_url"                    => "http://staging.amara.org/videos/s7TbkyDizi6k/info/",
+      "video"                        => "prx-test-1",
+      "thumbnail"                   => "",
+      "title"                       => "cmdline-test-1",
+      "video_url"                   => "https://archive.org/download/1-test-mp3.JRiaC2.popuparchive.org/test.ogg"
+    }.to_json
+    stub_request(:get, "https://www.amara.org/api2/partners/videos/s7TbkyDizi6k/").
+       to_return(body: response)
+
+    videos = Amara::Videos.new(api_key: 'thisisakey', api_username: 'test_user')
+
+    response = videos.get("s7TbkyDizi6k")
+    response.object.wont_be_nil
+    video = response.object
+    video.id.must_equal 's7TbkyDizi6k'
+  end
+
+  it "creates a new video" do
+    response = {
+      "all_urls"                    => ["https://archive.org/download/1-test-mp3.JRiaC2.popuparchive.org/test.ogg"],
+      "created"                     => "2013-08-29T15:35:25.518514",
+      "description"                 => "",
+      "duration"                    => nil,
+      "id"                          => "s7TbkyDizi6k",
+      "languages"                   => [],
+      "metadata"                    => {},
+      "original_language"           => "en",
+      "primary_audio_language_code" => "en",
+      "project"                     => nil,
+      "resource_uri"                => "/api2/partners/videos/s7TbkyDizi6k/",
+      "site_url"                    => "http://staging.amara.org/videos/s7TbkyDizi6k/info/",
+      "video"                        => "test-team",
+      "thumbnail"                   => "",
+      "title"                       => "title",
+      "video_url"                   => "https://archive.org/download/1-test-mp3.JRiaC2.popuparchive.org/test.ogg"
+    }.to_json
+
+    stub_request(:post, "https://www.amara.org/api2/partners/videos/").
+      with(:body => "{\"team\":\"test-team\",\"title\":\"title\",\"video_url\":\"https://archive.org/download/1-test-mp3.JRiaC2.popuparchive.org/test.ogg\",\"primary_audio_language_code\":\"en\"}",
+           :headers => {'Accept'=>'application/json', 'Content-Type'=>'application/json', 'Host'=>'www.amara.org:443', 'User-Agent'=>'Amara Ruby Gem 0.1.0', 'X-Api-Username'=>'test_user', 'X-Apikey'=>'thisisakey'}).
+      to_return(:status => 200, :body => response, :headers => {})
+
+    videos = Amara::Videos.new(api_key: 'thisisakey', api_username: 'test_user')
+    response = videos.create({
+      team:      'test-team',
+      title:     'title',
+      video_url: 'https://archive.org/download/1-test-mp3.JRiaC2.popuparchive.org/test.ogg',
+      primary_audio_language_code: 'en'
+    })
+
+    response.object.wont_be_nil
+    video = response.object
+    video.id.must_equal 's7TbkyDizi6k'
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: amara
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.1.0
 platform: ruby
 authors:
 - Andrew Kuklewicz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-30 00:00:00.000000000 Z
+date: 2013-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -151,17 +151,22 @@ files:
 - amara.gemspec
 - lib/.DS_Store
 - lib/amara.rb
+- lib/amara/activity.rb
 - lib/amara/api.rb
 - lib/amara/api_factory.rb
 - lib/amara/client.rb
 - lib/amara/configuration.rb
 - lib/amara/connection.rb
 - lib/amara/languages.rb
+- lib/amara/message.rb
 - lib/amara/response.rb
 - lib/amara/teams.rb
+- lib/amara/teams/applications.rb
 - lib/amara/teams/members.rb
 - lib/amara/teams/projects.rb
 - lib/amara/teams/safe_members.rb
+- lib/amara/teams/tasks.rb
+- lib/amara/users.rb
 - lib/amara/version.rb
 - lib/amara/videos.rb
 - lib/amara/videos/languages.rb
@@ -172,6 +177,7 @@ files:
 - test/teams/projects_test.rb
 - test/teams_test.rb
 - test/test_helper.rb
+- test/videos_test.rb
 homepage: https://github.com/PRX/amara
 licenses: []
 metadata: {}
@@ -201,3 +207,4 @@ test_files:
 - test/teams/projects_test.rb
 - test/teams_test.rb
 - test/test_helper.rb
+- test/videos_test.rb