clarify 1.1.1 → 2.0.0.alpha.1

data/spec/spec_helper.rb

@@ -1,12 +1,7 @@
+require 'simplecov'
 
-require "clarify"
-require "debugger"
+$LOAD_PATH << File.dirname(__FILE__) + '/../../lib/'
 
-Clarify.configure do |config|
-  config.api_key = ENV['CLARIFY_API_KEY']
-end
+require 'clarify'
 
-
-RSpec.configure do |config|
-  config.order = :random
-end
+srand RSpec.configuration.seed

data/src_readme/README_no_output.md

@@ -0,0 +1,186 @@
+
+[![Build Status][travis-image]][travis-url] [![Code Climate][cc-image]][cc-url]
+
+# How To
+
+You can get started in minutes using our Quickstarts:
+
+[http://clarify.io/docs/quickstarts/](http://clarify.io/docs/quickstarts/)
+
+## Basic Setup and Examples
+
+Require the library and initialize the Client, which takes care of
+configuration and http client setup.
+
+```ruby
+# setup.rb
+require 'clarify'
+require 'pp'
+
+clarify = Clarify::Client.new(api_key: 'docs-api-key')
+pp clarify
+```
+
+### Search for bundles
+
+```ruby
+# bundles_search.rb
+require 'clarify'
+
+clarify = Clarify::Client.new(api_key: 'docs-api-key')
+
+results = clarify.bundles.search('plane')
+
+results.each do |bundle_results, bundle_url|
+  # Fetch the bundle:
+  bundle = clarify.get(bundle_url)
+
+  puts "#{bundle.name} - #{bundle_url}"
+  bundle_results['term_results'].each do |term_result|
+    term_result['matches'].each do |match|
+      type = match['type']
+      match['hits'].each do |hit|
+        puts "\tmatched #{type} content at #{hit['start']} to #{hit['end']}"
+      end
+    end
+  end
+end
+```
+
+Example output of bundles_search.rb:
+```
+<output of bundles_search.rb>
+```
+
+### Get a list of bundles
+
+```ruby
+# list_bundles.rb
+require 'clarify'
+clarify = Clarify::Client.new(api_key: 'docs-api-key')
+
+clarify.bundles.fetch.each do |bundle_url|
+  puts " - #{bundle_url}"
+end
+```
+
+Example output of list_bundles.rb:
+```
+<output of list_bundles.rb>
+```
+
+### Fetch a particular bundle
+
+```ruby
+# bundle_fetch.rb
+require 'clarify'
+require 'pp'
+
+clarify = Clarify::Client.new(api_key: 'docs-api-key')
+
+bundle_url = '/v1/bundles/3fbca3fe3678495fb08fe939dbe4f1cd'
+bundle = clarify.get(bundle_url)
+puts "Bundle Name: #{bundle.name}"
+pp bundle
+```
+
+Example output of bundle_fetch.rb:
+```
+<output of bundle_fetch.rb>
+```
+
+### Get a list of bundles and their names
+
+```ruby
+# bundles_list_fetch.rb
+require 'clarify'
+require 'pp'
+
+clarify = Clarify::Client.new(api_key: 'docs-api-key')
+
+bundles = clarify.bundles.fetch
+
+bundles.each do |url|
+  bundle = clarify.get(url)
+  puts " - Bundle Name: #{bundle.name}"
+end
+```
+
+Example output of bundles_list_fetch.rb:
+```
+<output of bundles_list_fetch.rb>
+```
+
+### Create a bundle
+
+Here you will need your own API key. Creating the bundle will return a 204,
+which means it has been Created, but is not done processing.
+
+```ruby
+# bundle_create.rb
+require 'clarify'
+require 'pp'
+
+clarify = Clarify::Client.new(api_key: ENV['CLARIFY_API_KEY'])
+
+created_bundle = clarify.bundles.create!(
+  name: 'Harvard Sentences #1',
+  media_url: 'http://media.clarify.io/audio/samples/harvard-sentences-1.wav'
+)
+
+pp created_bundle
+```
+
+Example output of bundle_create.rb:
+```
+<output of bundle_create.rb>
+```
+
+## More Advanced Usage
+#
+### Get all of your searches over many pages
+
+```ruby
+# searches_paged_over.rb
+require 'clarify'
+require 'pp'
+
+clarify = Clarify::Client.new(api_key: 'docs-api-key')
+
+first_page = clarify.bundles.search('flight')
+clarify.pager(first_page).each do |result, bundle_url|
+  puts " - #{clarify.get(bundle_url).name}"
+  pp result
+end
+```
+
+Example output of searches_paged_over.rb:
+```
+<output of searches_paged_over.rb>
+```
+
+### Get all of your bundles over many pages
+
+```ruby
+# bundles_paged_over.rb
+require 'clarify'
+
+clarify = Clarify::Client.new(api_key: 'docs-api-key')
+
+first_page = clarify.bundles.fetch
+clarify.pager(first_page).each do |bundle_url|
+  puts " - #{clarify.get(bundle_url).name}"
+end
+```
+
+Example output of bundles_paged_over.rb:
+```
+<output of bundles_paged_over.rb>
+```
+
+
+[travis-image]: https://travis-ci.org/Clarify/clarify-ruby.svg
+[travis-url]: https://travis-ci.org/Clarify/clarify-ruby
+
+[cc-image]: https://codeclimate.com/github/Clarify/clarify-ruby/badges/gpa.svg
+[cc-url]: https://codeclimate.com/github/Clarify/clarify-ruby

data/src_readme/examples/bundle_create.rb

@@ -0,0 +1,11 @@
+require 'clarify'
+require 'pp'
+
+clarify = Clarify::Client.new(api_key: ENV['CLARIFY_API_KEY'])
+
+created_bundle = clarify.bundles.create!(
+  name: 'Harvard Sentences #1',
+  media_url: 'http://media.clarify.io/audio/samples/harvard-sentences-1.wav'
+)
+
+pp created_bundle

data/src_readme/examples/bundle_fetch.rb

@@ -0,0 +1,9 @@
+require 'clarify'
+require 'pp'
+
+clarify = Clarify::Client.new(api_key: 'docs-api-key')
+
+bundle_url = '/v1/bundles/3fbca3fe3678495fb08fe939dbe4f1cd'
+bundle = clarify.get(bundle_url)
+puts "Bundle Name: #{bundle.name}"
+pp bundle

data/src_readme/examples/bundles_list_fetch.rb

@@ -0,0 +1,11 @@
+require 'clarify'
+require 'pp'
+
+clarify = Clarify::Client.new(api_key: 'docs-api-key')
+
+bundles = clarify.bundles.fetch
+
+bundles.each do |url|
+  bundle = clarify.get(url)
+  puts " - Bundle Name: #{bundle.name}"
+end

data/src_readme/examples/bundles_paged_over.rb

@@ -0,0 +1,8 @@
+require 'clarify'
+
+clarify = Clarify::Client.new(api_key: 'docs-api-key')
+
+first_page = clarify.bundles.fetch
+clarify.pager(first_page).each do |bundle_url|
+  puts " - #{clarify.get(bundle_url).name}"
+end

data/src_readme/examples/bundles_search.rb

@@ -0,0 +1,20 @@
+require 'clarify'
+
+clarify = Clarify::Client.new(api_key: 'docs-api-key')
+
+results = clarify.bundles.search('plane')
+
+results.each do |bundle_results, bundle_url|
+  # Fetch the bundle:
+  bundle = clarify.get(bundle_url)
+
+  puts "#{bundle.name} - #{bundle_url}"
+  bundle_results['term_results'].each do |term_result|
+    term_result['matches'].each do |match|
+      type = match['type']
+      match['hits'].each do |hit|
+        puts "\tmatched #{type} content at #{hit['start']} to #{hit['end']}"
+      end
+    end
+  end
+end

data/src_readme/examples/list_bundles.rb

@@ -0,0 +1,6 @@
+require 'clarify'
+clarify = Clarify::Client.new(api_key: 'docs-api-key')
+
+clarify.bundles.fetch.each do |bundle_url|
+  puts " - #{bundle_url}"
+end

data/src_readme/examples/searches_paged_over.rb

@@ -0,0 +1,10 @@
+require 'clarify'
+require 'pp'
+
+clarify = Clarify::Client.new(api_key: 'docs-api-key')
+
+first_page = clarify.bundles.search('flight')
+clarify.pager(first_page).each do |result, bundle_url|
+  puts " - #{clarify.get(bundle_url).name}"
+  pp result
+end

data/src_readme/examples/setup.rb

@@ -0,0 +1,5 @@
+require 'clarify'
+require 'pp'
+
+clarify = Clarify::Client.new(api_key: 'docs-api-key')
+pp clarify

data/src_readme/make.rb

@@ -0,0 +1,56 @@
+#!/usr/bin/env ruby
+
+require 'erb'
+
+# Build context and helpers for generating the documentation.
+class Context
+  def initialize(opts = {})
+    @output = opts.fetch(:include_output, true)
+  end
+
+  def example_with_output(file)
+    "#{example(file)}\n\n#{output_with_lead(file)}"
+  end
+
+  def example(file)
+    "```ruby\n# #{file}\n#{File.read(fn(file))}```"
+  end
+
+  def output_with_lead(file)
+    "Example output of #{file}:\n#{output(file)}"
+  end
+
+  def output(file)
+    "```\n#{run_file(file)}```"
+  end
+
+  def run_file(file)
+    return "<output of #{file}>\n" unless @output
+
+    result = nil
+    IO.popen(['ruby', fn(file)], 'r', err: [:child, :out]) do |io|
+      result = io.read
+    end
+
+    result
+  end
+
+  def fn(file)
+    "src_readme/examples/#{file}"
+  end
+
+  def bound
+    binding
+  end
+end
+
+def write_out(file, opts = {})
+  template = File.read('src_readme/readme.md.erb')
+  erb = ERB.new(template)
+  context = Context.new(opts)
+
+  File.write(file, erb.result(context.bound))
+end
+
+write_out('README.md')
+write_out('src_readme/README_no_output.md', include_output: false)

data/src_readme/readme.md.erb

@@ -0,0 +1,55 @@
+
+[![Build Status][travis-image]][travis-url] [![Code Climate][cc-image]][cc-url]
+
+# How To
+
+You can get started in minutes using our Quickstarts:
+
+[http://clarify.io/docs/quickstarts/](http://clarify.io/docs/quickstarts/)
+
+## Basic Setup and Examples
+
+Require the library and initialize the Client, which takes care of
+configuration and http client setup.
+
+<%= example('setup.rb') %>
+
+### Search for bundles
+
+<%= example_with_output('bundles_search.rb') %>
+
+### Get a list of bundles
+
+<%= example_with_output('list_bundles.rb') %>
+
+### Fetch a particular bundle
+
+<%= example_with_output('bundle_fetch.rb') %>
+
+### Get a list of bundles and their names
+
+<%= example_with_output('bundles_list_fetch.rb') %>
+
+### Create a bundle
+
+Here you will need your own API key. Creating the bundle will return a 204,
+which means it has been Created, but is not done processing.
+
+<%= example_with_output('bundle_create.rb') %>
+
+## More Advanced Usage
+#
+### Get all of your searches over many pages
+
+<%= example_with_output('searches_paged_over.rb') %>
+
+### Get all of your bundles over many pages
+
+<%= example_with_output('bundles_paged_over.rb') %>
+
+
+[travis-image]: https://travis-ci.org/Clarify/clarify-ruby.svg
+[travis-url]: https://travis-ci.org/Clarify/clarify-ruby
+
+[cc-image]: https://codeclimate.com/github/Clarify/clarify-ruby/badges/gpa.svg
+[cc-url]: https://codeclimate.com/github/Clarify/clarify-ruby

metadata

@@ -1,69 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: clarify
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 2.0.0.alpha.1
 platform: ruby
 authors:
-- rubygeek
+- Clarify Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-20 00:00:00.000000000 Z
+date: 2015-03-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: httparty
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '0.13'
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: 0.13.1
-  type: :runtime
+        version: '1.5'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '0.13'
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: 0.13.1
+        version: '1.5'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '10.0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: cucumber
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '10.0'
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: 10.0.0
+        version: 1.3.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '10.0'
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: 10.0.0
+        version: 1.3.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -71,9 +59,6 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '3.0'
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: 3.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -81,64 +66,122 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '3.0'
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: 3.0.0
 - !ruby/object:Gem::Dependency
-  name: debugger
+  name: rspec-expectations
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.6'
-    - - '>='
+        version: 3.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 1.6.8
+        version: 0.29.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.6'
-    - - '>='
+        version: 0.29.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 1.6.8
+        version: 0.9.0
 description: Use the Clarify API to make your audio and video files searchable in
   just a few lines of code.
 email:
-- nola@rubygeek.com
+- support@clarify.io
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
 - .rspec
+- .simplecov
+- .travis.yml
+- CHANGELOG.md
+- Dockerfile
 - Gemfile
 - LICENSE
-- LICENSE.txt
 - README.md
 - Rakefile
 - clarify.gemspec
-- examples/create.rb
-- examples/delete.rb
-- examples/list.rb
-- examples/search.rb
-- examples/test.rb
+- cucumber.yml
+- features/create-bundles.feature
+- features/delete-bundle.feature
+- features/identity-steps.feature
+- features/list-bundles.feature
+- features/search-bundles.feature
+- features/step_definitions/curied_url_steps.rb
+- features/step_definitions/error_steps.rb
+- features/step_definitions/http_verification_step.rb
+- features/step_definitions/identity_steps.rb
+- features/step_definitions/list_steps.rb
+- features/support/env.rb
+- features/support/lib/curies.rb
+- features/support/lib/customer.rb
+- features/support/lib/exceptions.rb
+- features/support/lib/names.rb
 - lib/clarify.rb
-- lib/clarify/bundle.rb
+- lib/clarify/bundle_repository.rb
+- lib/clarify/client.rb
+- lib/clarify/collection_iterator.rb
 - lib/clarify/configuration.rb
-- lib/clarify/metadata.rb
-- lib/clarify/request.rb
-- lib/clarify/search.rb
-- lib/clarify/track.rb
+- lib/clarify/errors.rb
+- lib/clarify/response.rb
+- lib/clarify/response_factory.rb
+- lib/clarify/responses/bundle.rb
+- lib/clarify/responses/collection.rb
+- lib/clarify/responses/no_body.rb
+- lib/clarify/responses/search_collection.rb
+- lib/clarify/responses/tracks.rb
+- lib/clarify/rest_client.rb
 - lib/clarify/version.rb
-- spec/lib/clarify/bundle_spec.rb
-- spec/lib/clarify/configuration_spec.rb
-- spec/lib/clarify/metadata_spec.rb
-- spec/lib/clarify/search_spec.rb
-- spec/lib/clarify/track_spec.rb
+- spec/clarify/bundle_repository_spec.rb
+- spec/clarify/client_spec.rb
+- spec/clarify/collection_iterator_spec.rb
+- spec/clarify/configuration_spec.rb
+- spec/clarify/errors_spec.rb
+- spec/clarify/response_factory_spec.rb
+- spec/clarify/response_spec.rb
+- spec/clarify/responses/bundle_spec.rb
+- spec/clarify/responses/collection_spec.rb
+- spec/clarify/responses/search_collection_spec.rb
+- spec/clarify/responses/tracks_spec.rb
+- spec/clarify/rest_client_spec.rb
 - spec/spec_helper.rb
+- src_readme/README_no_output.md
+- src_readme/examples/bundle_create.rb
+- src_readme/examples/bundle_fetch.rb
+- src_readme/examples/bundles_list_fetch.rb
+- src_readme/examples/bundles_paged_over.rb
+- src_readme/examples/bundles_search.rb
+- src_readme/examples/list_bundles.rb
+- src_readme/examples/searches_paged_over.rb
+- src_readme/examples/setup.rb
+- src_readme/make.rb
+- src_readme/readme.md.erb
 homepage: http://www.clarify.io
 licenses:
 - MIT
@@ -154,9 +197,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - '>'
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.4.4
@@ -164,9 +207,31 @@ signing_key:
 specification_version: 4
 summary: Search audio and video in a few lines of code
 test_files:
-- spec/lib/clarify/bundle_spec.rb
-- spec/lib/clarify/configuration_spec.rb
-- spec/lib/clarify/metadata_spec.rb
-- spec/lib/clarify/search_spec.rb
-- spec/lib/clarify/track_spec.rb
+- features/create-bundles.feature
+- features/delete-bundle.feature
+- features/identity-steps.feature
+- features/list-bundles.feature
+- features/search-bundles.feature
+- features/step_definitions/curied_url_steps.rb
+- features/step_definitions/error_steps.rb
+- features/step_definitions/http_verification_step.rb
+- features/step_definitions/identity_steps.rb
+- features/step_definitions/list_steps.rb
+- features/support/env.rb
+- features/support/lib/curies.rb
+- features/support/lib/customer.rb
+- features/support/lib/exceptions.rb
+- features/support/lib/names.rb
+- spec/clarify/bundle_repository_spec.rb
+- spec/clarify/client_spec.rb
+- spec/clarify/collection_iterator_spec.rb
+- spec/clarify/configuration_spec.rb
+- spec/clarify/errors_spec.rb
+- spec/clarify/response_factory_spec.rb
+- spec/clarify/response_spec.rb
+- spec/clarify/responses/bundle_spec.rb
+- spec/clarify/responses/collection_spec.rb
+- spec/clarify/responses/search_collection_spec.rb
+- spec/clarify/responses/tracks_spec.rb
+- spec/clarify/rest_client_spec.rb
 - spec/spec_helper.rb