clarify 1.1.1 → 2.0.0.alpha.1

data/clarify.gemspec

@@ -6,8 +6,8 @@ require 'clarify/version'
 Gem::Specification.new do |spec|
   spec.name          = 'clarify'
   spec.version       = Clarify::VERSION
-  spec.authors       = ['rubygeek']
-  spec.email         = ['nola@rubygeek.com']
+  spec.authors       = ['Clarify Inc.']
+  spec.email         = ['support@clarify.io']
   spec.summary       = 'Search audio and video in a few lines of code'
   spec.description   = 'Use the Clarify API to make your audio and video files searchable in just a few lines of code.'
   spec.homepage      = 'http://www.clarify.io'
@@ -18,9 +18,12 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'httparty', '~> 0.13', '>= 0.13.1'
-  spec.add_development_dependency 'bundler', '~> 1.5'
-  spec.add_development_dependency 'rake', '~> 10.0', '>= 10.0.0'
-  spec.add_development_dependency 'rspec',  '~> 3.0', '>= 3.0.0'
-  spec.add_development_dependency 'debugger', '~> 1.6', '>= 1.6.8'
+  spec.add_development_dependency 'bundler',             '~> 1.5'
+  spec.add_development_dependency 'rake',                '~> 10.0'
+  spec.add_development_dependency 'cucumber',            '~> 1.3.0'
+  spec.add_development_dependency 'rspec',               '~> 3.0'
+  spec.add_development_dependency 'rspec-expectations',  '~> 3.2.0'
+  spec.add_development_dependency 'rubocop',             '~> 0.29.0'
+  spec.add_development_dependency 'simplecov',           '~> 0.9.0'
 end
+

data/cucumber.yml

@@ -0,0 +1 @@
+default: --color

data/features/create-bundles.feature

@@ -0,0 +1,10 @@
+Feature: As a user of the API, I am able to create a bundle.
+  Scenario: A user has added a new media file for processing.
+    Given I am using the environment's API key
+    And I know the following urls referenced as:
+      | name          | URL                                                                          |
+      | media:dorothy | http://media.clarify.io/audio/books/dorothyandthewizardinoz_01_baum_64kb.mp3 |
+    When I create a bundle named "Wizard of Oz" with the media url "[media:dorothy]"
+    When I request a list of bundles
+    Then I should get the HTTP status code 200
+    And my results should incude a bundle named "Wizard of Oz"

data/features/delete-bundle.feature

@@ -0,0 +1,7 @@
+Feature: As a user of the API, I am able to delete a bundle.
+  Scenario: A user has added a new media file for processing.
+    Given I am using the environment's API key
+    And I have a bundle named "K.C."
+    When I delete my bundle
+    Then the server should not list my bundle
+

data/features/identity-steps.feature

@@ -0,0 +1,6 @@
+Feature: As an unauthenticated user, I get an exception that I can handle.
+  Scenario: I have not entered an API key, but attempt to connect anyway.
+    Given I am not using an API key
+    When I request a list of bundles without authentication
+    Then the response should be rejected with a 401 Unauthorized status code
+

data/features/list-bundles.feature

@@ -0,0 +1,13 @@
+Feature: As a user of the API, I am able to list my submitted bundles.
+  Scenario: I am building an index page to my bundle collection.
+    Given I am using the documentation API key
+    And I know the following urls referenced as:
+      | name                          | URL                                                                                                                 |
+      | media:future-of-women-flying  | http://archive.org/download/Greatest_Speeches_of_the_20th_Century/TheFutureofWomeninFlying_64kb.mp3                 |
+      | media:watergate-tapes         | http://ia700200.us.archive.org/18/items/Greatest_Speeches_of_the_20th_Century/OnReleasingtheWatergateTapes_64kb.mp3 |
+      | media:resignation-address     | http://ia600200.us.archive.org/18/items/Greatest_Speeches_of_the_20th_Century/ResignationAddress-1974_64kb.mp3      |
+    When I request a list of bundles
+    Then I should get the HTTP status code 200
+    And my results should include a track with the URL "[media:future-of-women-flying]"
+    And my results should include a track with the URL "[media:watergate-tapes]"
+    And my results should include a track with the URL "[media:resignation-address]"

data/features/search-bundles.feature

@@ -0,0 +1,10 @@
+
+Feature: As a user of the API, I am able to search for bundles based on the content.
+  Scenario: I am building a search functionality into my application.
+    Given I am using the documentation API key
+    And I know the following urls referenced as:
+      | name                          | URL                                                                                                 |
+      | media:future-of-women-flying  | http://archive.org/download/Greatest_Speeches_of_the_20th_Century/TheFutureofWomeninFlying_64kb.mp3 |
+    When I search my bundles for the text "women"
+    Then I should get the HTTP status code 200
+    And my results should include a track with the URL "[media:future-of-women-flying]"

data/features/step_definitions/curied_url_steps.rb

@@ -0,0 +1,6 @@
+Given(/^I know the following urls referenced as:$/) do |table|
+  table.map_headers! { |header| header.downcase.to_sym }
+  table.hashes.each do |row|
+    curies[row[:name]] = row[:url]
+  end
+end

data/features/step_definitions/error_steps.rb

@@ -0,0 +1,4 @@
+
+Then(/^the response should be rejected with a 401 Unauthorized status code$/) do
+  expect(exceptions.caught.class.to_s).to eq('Clarify::UnauthenticatedError')
+end

data/features/step_definitions/http_verification_step.rb

@@ -0,0 +1,4 @@
+
+Then(/^I should get the HTTP status code (\d+)$/) do |code|
+  expect(@result.http_status_code).to eq code.to_i
+end

data/features/step_definitions/identity_steps.rb

@@ -0,0 +1,12 @@
+
+Given(/^I am using the documentation API key$/) do
+  customer.log_in_as_docs
+end
+
+Given(/^I am not using an API key$/) do
+  customer.clear_api_key
+end
+
+Given(/^I am using the environment's API key$/) do
+  customer.log_in_via_environment
+end

data/features/step_definitions/list_steps.rb

@@ -0,0 +1,76 @@
+
+When(/^I request a list of bundles without authentication$/) do
+  begin
+    @result = customer.bundle_repository.fetch
+  rescue Clarify::StandardError => err
+    exceptions.caught = err
+  end
+end
+
+When(/^I request a list of bundles$/) do
+  @result = customer.bundle_repository.fetch
+end
+
+When(/^I search my bundles for the text "(.*?)"$/) do |query_string|
+  @result = customer.bundle_repository.search(query_string)
+end
+
+Then(/^my results should include a track with the URL "(.*?)"$/) do |url|
+  if @result.is_a? Clarify::Responses::SearchCollection
+    urls = @result.map { |_, bundle_url| bundle_url }
+  else
+    urls = @result.to_a
+  end
+
+  bundles = urls.map { |bundle_url| customer.restclient.get(bundle_url) }
+
+  tracks = bundles.map do |bundle|
+    customer.restclient.get(bundle.relation('clarify:tracks'))
+  end
+  media_urls = tracks.map do |tracks_resource|
+    tracks_resource.map { |track| track['media_url'] }
+  end.flatten
+
+  expect(media_urls).to include(curies.resolve(url))
+end
+
+# rubocop:disable Metrics/LineLength
+When(/^I create a bundle named "(.*?)" with the media url "(.*?)"$/) do |name, url|
+  # rubocop:enable Metrics/LineLength
+  bundle = {
+    name: names.translate(name),
+    media_url: curies.resolve(url)
+  }
+  customer.bundle_repository.create!(bundle)
+end
+
+Then(/^my results should incude a bundle named "(.*?)"$/) do |name|
+  all_results = Clarify::CollectionIterator.new(customer.restclient, @result)
+  bundles = all_results.map do |item|
+    customer.restclient.get(item)
+  end
+  bundle_names = bundles.map(&:name)
+
+  expect(bundle_names).to include(names.translate(name))
+end
+
+Given(/^I have a bundle named "(.*?)"$/) do |name|
+  bundle = {
+    name: names.translate(name)
+  }
+  @my_bundle = customer.bundle_repository.create!(bundle)
+end
+
+When(/^I delete my bundle$/) do
+  customer.bundle_repository.delete!(@my_bundle)
+end
+
+Then(/^the server should not list my bundle$/) do
+  result = customer.bundle_repository.fetch
+  all_results = Clarify::CollectionIterator.new(customer.restclient, result)
+  bundle_urls = all_results.map do |item|
+    item['href']
+  end
+
+  expect(bundle_urls).to_not include(@my_bundle.relation('self'))
+end

data/features/support/env.rb

@@ -0,0 +1,36 @@
+
+$LOAD_PATH << File.dirname(__FILE__) + '/lib/'
+$LOAD_PATH << File.dirname(__FILE__) + '/../../lib/'
+
+require 'simplecov'
+require 'clarify'
+require 'customer'
+require 'exceptions'
+require 'curies'
+
+# EnvHelpers is
+class EnvHelpers
+  def customer
+    @customer ||= ClarifyTests::Customer.new
+  end
+
+  def exceptions
+    @exceptions ||= ClarifyTests::Exceptions.new
+  end
+
+  def curies
+    @curies ||= ClarifyTests::Curies.new
+  end
+
+  def names
+    @names ||= ClarifyTests::Names.new
+  end
+end
+
+World do
+  EnvHelpers.new
+end
+
+After do
+  exceptions.raise_pending!
+end

data/features/support/lib/curies.rb

@@ -0,0 +1,19 @@
+
+module ClarifyTests
+  # The Curies class helps improve readability in URL-based tests by
+  # introducing a replacable reference.
+  class Curies
+    def initialize
+      @curies = {}
+    end
+
+    def []=(name, value)
+      @curies["[#{name}]"] = value
+    end
+
+    def resolve(url)
+      return url unless url[0] == '['
+      @curies.fetch(url)
+    end
+  end
+end

data/features/support/lib/customer.rb

@@ -0,0 +1,41 @@
+
+module ClarifyTests
+  # The Customer represents a user of the API. The Customer might do things like
+  # log in with particular keys, or create RestClients, Configurations, etc.
+  class Customer
+    attr_reader :api_key
+
+    def initialize
+    end
+
+    def log_in_as_docs
+      self.api_key = 'docs-api-key'
+    end
+
+    def log_in_via_environment
+      self.api_key = ENV.fetch('CLARIFY_API_KEY')
+    end
+
+    def clear_api_key
+      self.api_key = ''
+    end
+
+    def api_key=(val)
+      @api_key = val
+
+      @client = nil
+    end
+
+    def bundle_repository
+      client.bundle_repository
+    end
+
+    def restclient
+      client.restclient
+    end
+
+    def client
+      @client ||= Clarify::Client.new(api_key: api_key)
+    end
+  end
+end

data/features/support/lib/exceptions.rb

@@ -0,0 +1,27 @@
+
+module ClarifyTests
+  # Used for catching and re-throwing exceptions used in tests. Guarantees that
+  # an exception won't be swalloawed when integrated with After commands.
+  class Exceptions
+    attr_writer :caught
+
+    def initialize
+      @caught = nil
+    end
+
+    def caught
+      exception = @caught
+      @caught = nil
+
+      exception
+    end
+
+    def raise_pending!
+      fail @caught if exception?
+    end
+
+    def exception?
+      !@caught.nil?
+    end
+  end
+end

data/features/support/lib/names.rb

@@ -0,0 +1,16 @@
+
+require 'securerandom'
+
+module ClarifyTests
+  # Take names you use in a test and make them unique, guaranteeing two tests
+  # can't trample on the same account.
+  class Names
+    def translate(name)
+      "#{uuid}{#{name}}"
+    end
+
+    def uuid
+      @uuid ||= SecureRandom.uuid
+    end
+  end
+end

data/lib/clarify.rb

@@ -1,17 +1,19 @@
-require "clarify/version"
-require "clarify/configuration"
-require "clarify/bundle"
-require "clarify/request"
-require "clarify/metadata"
-require "clarify/track"
-require "clarify/search"
 
+# The Clarify API SDK
 module Clarify
-  class << self
-    attr_accessor :configuration
-  end
-  def self.configure
-    self.configuration ||= Configuration.new
-    yield(configuration)
-  end
 end
+
+require 'clarify/bundle_repository'
+require 'clarify/rest_client'
+require 'clarify/configuration'
+require 'clarify/errors'
+require 'clarify/client'
+require 'clarify/response'
+require 'clarify/response_factory'
+require 'clarify/responses/bundle'
+require 'clarify/responses/collection'
+require 'clarify/responses/search_collection'
+require 'clarify/responses/no_body'
+require 'clarify/collection_iterator'
+require 'clarify/responses/tracks'
+require 'clarify/version'

data/lib/clarify/bundle_repository.rb

@@ -0,0 +1,26 @@
+
+module Clarify
+  # A simple entrypoint to the API. Exposes access to search and CRUD
+  # operations on Bundles.
+  class BundleRepository
+    def initialize(restclient)
+      @restclient = restclient
+    end
+
+    def fetch
+      @restclient.get('/v1/bundles')
+    end
+
+    def search(query_string)
+      @restclient.get('/v1/search', query: query_string)
+    end
+
+    def create!(about)
+      @restclient.post('/v1/bundles', about)
+    end
+
+    def delete!(bundle)
+      @restclient.delete(bundle.relation!('self'))
+    end
+  end
+end

data/lib/clarify/client.rb

@@ -0,0 +1,51 @@
+
+module Clarify
+  # The Client simplifies the configuration and bootstrapping of the restclient
+  # and bundle repository.
+  class Client
+    def initialize(config, opts = {})
+      @config = config
+      @klass_restclient = opts.fetch(:rest_client, Clarify::RestClient)
+      @klass_configuration = opts.fetch(:configuration, Clarify::Configuration)
+      @klass_bundle_repository = opts.fetch(:bundle_repository,
+                                            Clarify::BundleRepository)
+      @klass_iterator = opts.fetch(:iterator,  Clarify::CollectionIterator)
+    end
+
+    def get(url, params = {})
+      restclient.get(url, params)
+    end
+
+    def put(url, params = {})
+      restclient.put(url, params)
+    end
+
+    def post(url, params = {})
+      restclient.post(url, params)
+    end
+
+    def delete(url, params = {})
+      restclient.delete(url, params)
+    end
+
+    def pager(collection)
+      @klass_iterator.new(restclient, collection)
+    end
+
+    def bundles
+      bundle_repository
+    end
+
+    def bundle_repository
+      @bundle_repository ||= @klass_bundle_repository.new(restclient)
+    end
+
+    def restclient
+      @restclient ||= @klass_restclient.new(configuration)
+    end
+
+    def configuration
+      @configuration ||= @klass_configuration.new(@config)
+    end
+  end
+end