clarify 1.1.1 → 2.0.0.alpha.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 18179d891742e09939fedb3b2073db80bf3e87f9
-  data.tar.gz: 70e075ae0bd8788d63663dd4f4fc3697f57cdd7c
+  metadata.gz: 27ee463c9c617e7b5fe25e15bcab7a015b2a773d
+  data.tar.gz: aa70eb477ccd681645764b8c60140acbb389cb2e
 SHA512:
-  metadata.gz: 0489cdd40b5e83b8f46f5fa6a0ccecd3581ec13fbc3e1be6022d76041fcb68fcdcd101f5185627f9f411e5239aaa163d021532f9b8a303c45856fb829a6138cf
-  data.tar.gz: 40a9112bf243b525e4c80f01b8a3371ca9c086077c2ec68c38597cdb11c02594d63ed960c91794b6809178a0591c0bdfe8d8314995487482f3232af22cdd38e2
+  metadata.gz: cfa320f5bf403e49fca2ff15569f4dfdbe8968cafc9e82c13c440b26bce52d9e9501037b4914ad97521e7bae6359d2298f6aa9ce8e1cc5b73383f0ee334ba770
+  data.tar.gz: 9bf3beeef829c852382395da189228cf0844320373d3992a2308fe8ac80ffb809b37508d035a7f56fdbf482d5dac2c7dfaa5df929cb543e8b21b2e80f3b08403

data/.gitignore

@@ -1,18 +1,4 @@
-*.gem
-*.rbc
-.bundle
-.config
-.yardoc
 Gemfile.lock
-InstalledFiles
-_yardoc
 coverage
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp
-.idea/*
+*.sw*
+

data/.rspec

@@ -1,3 +1,5 @@
 --color
+--tty
 --require spec_helper
 --format=documentation
+--order rand

data/.simplecov

@@ -0,0 +1,3 @@
+SimpleCov.start do
+  SimpleCov.minimum_coverage 100
+end

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+- ruby-head
+- 2.2.1
+env:
+  global:
+    secure: Lshn6Nxm71QuAJmo3AuF4N0UmsRzXwXY2WZhYXOQgfyIe3YibO/MyqQKWQx0CE3UcuR8gEQAA35potLZxXBk0OCbtrJ7UWdVVWp7NkAbWK05f5KAK2R7XT8/5IEPUlicmE/UnnPsJ08z2hG64ncGA0gmUaY/B+OAqeRfim3umh4=

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+# v2.0.0.alpha.1
+
+Rebuilt the client to more closely match the intended usage of the API itself.
+

data/Dockerfile

@@ -0,0 +1,11 @@
+FROM ruby:latest
+
+RUN mkdir -p /data/lib/clarify/
+WORKDIR /data
+ADD Gemfile clarify.gemspec /data/
+ADD lib/clarify/version.rb /data/lib/clarify/version.rb
+RUN bundle install
+
+ADD features /data/features
+
+ENTRYPOINT [ "rake" ]

data/Gemfile

@@ -1,4 +1,4 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
-# Specify your gem's dependencies in clarify.gemspec
 gemspec
+

data/LICENSE

@@ -2,7 +2,7 @@ The MIT License (MIT)
 
 Copyright (c) 2014 Clarify, Inc
 
-Written by Nola Stowe @rubygeek
+Written by Clarify Inc. support@clarify.io
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,93 +1,248 @@
-[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/Clarify/clarify-ruby/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/Clarify/clarify-ruby/?branch=master) [![Code Climate](https://codeclimate.com/github/Clarify/clarify-ruby/badges/gpa.svg)](https://codeclimate.com/github/Clarify/clarify-ruby)
 
-# Clarify
+[![Build Status][travis-image]][travis-url] [![Code Climate][cc-image]][cc-url]
 
-A gem to communicate with the ClarifyAPI.
+# How To
 
-### Installation
+You can get started in minutes using our Quickstarts:
 
-Add this line to your application's Gemfile:
+[http://clarify.io/docs/quickstarts/](http://clarify.io/docs/quickstarts/)
 
-    gem 'clarify'
+## Basic Setup and Examples
 
-And then execute:
+Require the library and initialize the Client, which takes care of
+configuration and http client setup.
 
-    $ bundle
+```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')
 
-Or install it yourself as:
+results = clarify.bundles.search('plane')
 
-    $ gem install clarify
+results.each do |bundle_results, bundle_url|
+  # Fetch the bundle:
+  bundle = clarify.get(bundle_url)
 
-add a configuration block to an initializer if you are using rails or in an include file:
+  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:
+```
+The Future of Women in Flying - /v1/bundles/3fbca3fe3678495fb08fe939dbe4f1cd
+	matched audio content at 68.92 to 69.31
+First American in Earth Orbit - /v1/bundles/72aaa17a9da745c9be41ab64b60319cb
+	matched audio content at 99.25 to 99.43
 ```
+
+### Get a list of bundles
+
+```ruby
+# list_bundles.rb
 require 'clarify'
+clarify = Clarify::Client.new(api_key: 'docs-api-key')
 
-Clarify.configure do |config|
-  config.api_key = 'CLARIFY_API_KEY'   
-  # if key in ENV   
-  # config.api_key = ENV['CLARIFY_API_KEY']
-  config.version = 1  #default is latest api version
+clarify.bundles.fetch.each do |bundle_url|
+  puts " - #{bundle_url}"
 end
 ```
 
-It doesn't have to be in ENV variable but that is an option.
+Example output of list_bundles.rb:
+```
+ - /v1/bundles/3fbca3fe3678495fb08fe939dbe4f1cd
+ - /v1/bundles/2a112c5b3e944802b932b0ddbf068c37
+ - /v1/bundles/ca4fbc504c6940cd96f270a0ca903917
+ - /v1/bundles/378efa8d163240478ae7d460c20fdb41
+ - /v1/bundles/4577432c51ab4fcdbed34be16ba363a2
+ - /v1/bundles/72aaa17a9da745c9be41ab64b60319cb
+ - /v1/bundles/2a0a63d07c6b46f99638edb961bc08f6
+ - /v1/bundles/45a8a6849e1948cea8bbb8dcb3440b68
+```
 
-**Remember never to check in your API key to a public repository!**
+### Fetch a particular bundle
 
-Your API key is found on your [application page](https://developer.clarify.io/apps/list/).
+```ruby
+# bundle_fetch.rb
+require 'clarify'
+require 'pp'
 
-If you wish to store your API key in your environment:
+clarify = Clarify::Client.new(api_key: 'docs-api-key')
 
-In bash:
+bundle_url = '/v1/bundles/3fbca3fe3678495fb08fe939dbe4f1cd'
+bundle = clarify.get(bundle_url)
+puts "Bundle Name: #{bundle.name}"
+pp bundle
+```
 
-    export CLARIFY_API_KEY=atYIFLDSDFsdfssSsd+fsfsdfsd+p+PCwA
+Example output of bundle_fetch.rb:
+```
+Bundle Name: The Future of Women in Flying
+#<Clarify::Responses::Bundle:0x007fc9c3171918
+ @body=
+  {"id"=>"3fbca3fe3678495fb08fe939dbe4f1cd",
+   "version"=>1,
+   "type"=>"audio",
+   "name"=>"The Future of Women in Flying",
+   "created"=>"2014-04-08T18:37:35.420Z",
+   "updated"=>"2014-04-08T18:37:35.420Z",
+   "_class"=>"Bundle",
+   "_links"=>
+    {"self"=>{"href"=>"/v1/bundles/3fbca3fe3678495fb08fe939dbe4f1cd"},
+     "curies"=>
+      [{"href"=>"/docs/rels/{rel}", "name"=>"clarify", "templated"=>true}],
+     "clarify:metadata"=>
+      {"href"=>"/v1/bundles/3fbca3fe3678495fb08fe939dbe4f1cd/metadata"},
+     "clarify:tracks"=>
+      {"href"=>"/v1/bundles/3fbca3fe3678495fb08fe939dbe4f1cd/tracks"}}},
+ @response=#<Net::HTTPOK 200 OK readbody=true>>
+```
 
-If you don't want to load it in your bash file, you can add it on the command line:
+### Get a list of bundles and their names
 
-    CLARIFY_API_KEY=atYIFLDSDFsdfssSsd+fsfsdfsd+p+PCwA rails s
+```ruby
+# bundles_list_fetch.rb
+require 'clarify'
+require 'pp'
 
-Or on [Heroku](http://www.heroku)
+clarify = Clarify::Client.new(api_key: 'docs-api-key')
 
-    heroku config:set CLARIFY_API_KEY=atYIFLDSDFsdfssSsd+fsfsdfsd+p+PCwA
+bundles = clarify.bundles.fetch
 
-[Read more on heroku environment variables](https://devcenter.heroku.com/articles/config-vars)
+bundles.each do |url|
+  bundle = clarify.get(url)
+  puts " - Bundle Name: #{bundle.name}"
+end
+```
 
-By default, it uses the newest version of the API.
+Example output of bundles_list_fetch.rb:
+```
+ - Bundle Name: The Future of Women in Flying
+ - Bundle Name: Election Eve Campaign Speech
+ - Bundle Name: Address to the Women of America
+ - Bundle Name: Address to Congress - Baseball
+ - Bundle Name: On Black Power
+ - Bundle Name: First American in Earth Orbit
+ - Bundle Name: On Releasing the Watergate Tapes
+ - Bundle Name: Resignation Address
+```
 
-## Usage
+### Create a bundle
 
-To begin using this library, initialize the Clarify object with your API key:
+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'
-@client = Clarify::Bundle.new
+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:
+```
+#<Clarify::Response:0x007ffb5428fc38
+ @body=
+  {"id"=>"415bd191442846a6839c88ae3956eb64",
+   "_class"=>"Ref",
+   "_links"=>
+    {"self"=>{"href"=>"/v1/bundles/415bd191442846a6839c88ae3956eb64"},
+     "curies"=>
+      [{"href"=>"/docs/rels/{rel}", "name"=>"clarify", "templated"=>true}],
+     "clarify:metadata"=>
+      {"href"=>"/v1/bundles/415bd191442846a6839c88ae3956eb64/metadata"},
+     "clarify:tracks"=>
+      {"href"=>"/v1/bundles/415bd191442846a6839c88ae3956eb64/tracks"}}},
+ @response=#<Net::HTTPCreated 201 Created readbody=true>>
 ```
 
-Then add an audio or video file to your search index:
+## More Advanced Usage
+#
+### Get all of your searches over many pages
 
 ```ruby
-bundle = @client.create(:name => "Harvard Sentences",
-        :media_url => "http://media.clarify.io/audio/samples/harvard-sentences-1.wav")
-bundle.data[:id]
+# 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:
+```
+ - First American in Earth Orbit
+{"score"=>1,
+ "term_results"=>
+  [{"score"=>0.379,
+    "matches"=>
+     [{"type"=>"audio",
+       "track"=>0,
+       "hits"=>
+        [{"start"=>67.41, "end"=>67.55}, {"start"=>92.76, "end"=>92.94}]}]}]}
 ```
 
-Within minutes your file will be added to your index and available via a simple search:
+### Get all of your bundles over many pages
 
 ```ruby
-@client = Clarify::Search.new
-results = @client.perform(:query => "dorothy").data
-bundles = results[:_links][:items]
+# 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
 ```
 
-See more examples for listing, getting, and deleting bundles etc. in the /examples folder.
+Example output of bundles_paged_over.rb:
+```
+ - The Future of Women in Flying
+ - Election Eve Campaign Speech
+ - Address to the Women of America
+ - Address to Congress - Baseball
+ - On Black Power
+ - First American in Earth Orbit
+ - On Releasing the Watergate Tapes
+ - Resignation Address
+```
 
-## Contributing
 
-1. Fork it to your github user ie: ( `http://github.com/my-github-username/clarify-ruby/` )
-2. Create your feature branch and rspec tests (`git checkout -b my-new-feature`)
-3. Run the rspec tests with `rake spec`
-4. Commit your changes (`git commit -am 'Add some feature'`)
-5. Push to the branch (`git push origin my-new-feature`)
-6. Create new Pull Request
+[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/Rakefile

@@ -1,10 +1,68 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+require 'cucumber/rake/task'
+require 'rake/clean'
 
-require "rspec/core/rake_task"
+CLEAN.include(FileList['coverage'])
+
+task default: [:test]
+task test: [:clean, :rubocop, :spec, :clean, :features, :docs]
+task docs: [:examples, :build_docs, :no_doc_change]
 
 RSpec::Core::RakeTask.new(:spec) do |s|
   s.pattern = 'spec/**/*.rb'
 end
 
-task :default => :spec
-task :test => :spec
+RuboCop::RakeTask.new(:rubocop) do |task|
+  task.patterns = ['**/*.rb']
+  task.fail_on_error = true
+end
+
+Cucumber::Rake::Task.new(:features) do |t|
+    t.cucumber_opts = "features --format pretty"
+end
+
+task :build_docs do
+  pid = fork do
+    exec('ruby', 'src_readme/make.rb')
+  end
+
+  Process.wait(pid)
+
+  if $?.exitstatus > 0
+    puts "Readme build failed!"
+    exit 1
+  end
+end
+
+task :no_doc_change do
+  pid = fork do
+    exec('git', 'diff', '--exit-code', 'src_readme/README_no_output.md')
+  end
+
+  Process.wait(pid)
+
+  if $?.exitstatus > 0
+    puts "Readme build changed the README.md! Must rebuild and commit."
+    exit 1
+  end
+end
+
+task :examples do
+  FileList['src_readme/examples/*.rb'].each do |file|
+    puts "Testing example: #{file}"
+
+    pid = fork do
+      exec('ruby', file)
+    end
+    Process.wait(pid)
+
+    if $?.exitstatus > 0
+      puts "Example #{file} failed!"
+      exit 1
+    end
+
+    puts ""
+  end
+end