clarify 1.0.0 → 1.1.1

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    MzBkMDZjYzI0OTBlMmQxYmI2NzRiY2E0NTNmNjVmNmFmMDc1MWI0YQ==
-  data.tar.gz: !binary |-
-    NGI4MWVhMGQ4NmE2OGNmYmZhNGVjNjJmYzI4NTIzMWMxYjM0OTk5NA==
+SHA1:
+  metadata.gz: 18179d891742e09939fedb3b2073db80bf3e87f9
+  data.tar.gz: 70e075ae0bd8788d63663dd4f4fc3697f57cdd7c
 SHA512:
-  metadata.gz: !binary |-
-    YjA3N2ZiZjc2ZGE0NDMxNTY0ZjJlZDFiMjU2NzJlNmU4ZmI4NDllMWE2ZjFm
-    Yjk0NGE2MzY3NmY4OGMyOTc4MWE1NWEwNTZiNTk3NWE0NjNlOGQwNzc0Mjlj
-    NzA0MDUxODBkNzJmMWY4MWIzMTMwZDRhNTJmMTM0N2M2Yzg4ZmY=
-  data.tar.gz: !binary |-
-    NWFmNDI2MmI5MjQwNzY0ZTY0NzA2YTYwMmFhODllZTI1MjIwNzRiN2IwMDc4
-    M2M3MDM4NDQxMTQ1YTg1MWNkNmNlMGU0MDU0YWU5M2NhMmM4NGJhN2QzMzI1
-    ZWZlZjU4MDI1OGQyZjAxMDVjNGFhNmEzNmRmYmRkMTZlMGUwN2Q=
+  metadata.gz: 0489cdd40b5e83b8f46f5fa6a0ccecd3581ec13fbc3e1be6022d76041fcb68fcdcd101f5185627f9f411e5239aaa163d021532f9b8a303c45856fb829a6138cf
+  data.tar.gz: 40a9112bf243b525e4c80f01b8a3371ca9c086077c2ec68c38597cdb11c02594d63ed960c91794b6809178a0591c0bdfe8d8314995487482f3232af22cdd38e2

data/.gitignore

@@ -15,3 +15,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+.idea/*

data/README.md

@@ -1,8 +1,10 @@
+[![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
 
 A gem to communicate with the ClarifyAPI.
 
-## Installation
+### Installation
 
 Add this line to your application's Gemfile:
 
@@ -19,6 +21,8 @@ Or install it yourself as:
 add a configuration block to an initializer if you are using rails or in an include file:
 
 ```
+require 'clarify'
+
 Clarify.configure do |config|
   config.api_key = 'CLARIFY_API_KEY'   
   # if key in ENV   
@@ -31,7 +35,7 @@ It doesn't have to be in ENV variable but that is an option.
 
 **Remember never to check in your API key to a public repository!**
 
-Your API key is found on your [application page](https://developer.clarify.io/apps).
+Your API key is found on your [application page](https://developer.clarify.io/apps/list/).
 
 If you wish to store your API key in your environment:
 
@@ -49,11 +53,34 @@ Or on [Heroku](http://www.heroku)
 
 [Read more on heroku environment variables](https://devcenter.heroku.com/articles/config-vars)
 
-By default, it uses the newest version of the API. If you want to use a specific version use: 
+By default, it uses the newest version of the API.
 
 ## Usage
 
-    Clarify::Bundle.new.find_all       
+To begin using this library, initialize the Clarify object with your API key:
+
+```ruby
+require 'clarify'
+@client = Clarify::Bundle.new
+```
+
+Then add an audio or video file to your search index:
+
+```ruby
+bundle = @client.create(:name => "Harvard Sentences",
+        :media_url => "http://media.clarify.io/audio/samples/harvard-sentences-1.wav")
+bundle.data[:id]
+```
+
+Within minutes your file will be added to your index and available via a simple search:
+
+```ruby
+@client = Clarify::Search.new
+results = @client.perform(:query => "dorothy").data
+bundles = results[:_links][:items]
+```
+
+See more examples for listing, getting, and deleting bundles etc. in the /examples folder.
 
 ## Contributing
 

data/examples/create.rb

@@ -0,0 +1,14 @@
+require 'clarify'
+
+# This assumes that you set up your key in the environment using: export CLARIFY_API_KEY=abcde12345
+Clarify.configure do |config|
+  # config.api_key = 'CLARIFY_API_KEY'
+  # if key in ENV
+  config.api_key = ENV['CLARIFY_API_KEY']
+end
+
+client = Clarify::Bundle.new
+
+bundle = client.create(:name => "Dorothy and the Wizard of Oz",
+    :media_url => "http://media.clarify.io/audio/books/dorothyandthewizardinoz_01_baum_64kb.mp3")
+puts bundle.data[:id]

data/examples/delete.rb

@@ -0,0 +1,12 @@
+
+require 'clarify'
+
+# This assumes that you set up your key in the environment using: export CLARIFY_API_KEY=abcde12345
+Clarify.configure do |config|
+  # config.api_key = 'CLARIFY_API_KEY'
+  # if key in ENV
+  config.api_key = ENV['CLARIFY_API_KEY']
+end
+
+client = Clarify::Bundle.new
+client.delete("abc123")

data/examples/list.rb

@@ -0,0 +1,14 @@
+
+require 'clarify'
+
+# This assumes that you set up your key in the environment using: export CLARIFY_API_KEY=abcde12345
+Clarify.configure do |config|
+  # config.api_key = 'CLARIFY_API_KEY'
+  # if key in ENV
+  config.api_key = ENV['CLARIFY_API_KEY']
+end
+
+client = Clarify::Bundle.new
+
+bundles = client.find_all.data[:_links][:items]
+bundles.each { |bundle| puts bundle[:href]  }

data/examples/search.rb

@@ -0,0 +1,26 @@
+
+require 'clarify'
+
+# This assumes that you set up your key in the environment using: export CLARIFY_API_KEY=abcde12345
+Clarify.configure do |config|
+  # config.api_key = 'CLARIFY_API_KEY'
+  # if key in ENV
+  config.api_key = ENV['CLARIFY_API_KEY']
+end
+
+client = Clarify::Search.new
+results = client.perform(:query => "dorothy").data
+bundles = results[:_links][:items]
+
+_bundle = Clarify::Bundle.new
+
+bundles.each do |bundle|
+  _id = bundle[:href][12..44]
+  test = _bundle.find(_id)
+  puts test.data[:name]
+  i = bundles.find_index(bundle)
+  matches = results[:item_results][i][:term_results][0][:matches][0][:hits]
+  matches.each do |match|
+    puts match[:start].to_s + " -- " + match[:end].to_s
+  end
+end

data/examples/test.rb

@@ -0,0 +1,15 @@
+
+require 'clarify'
+
+# This assumes that you set up your key in the environment using: export CLARIFY_API_KEY=abcde12345
+Clarify.configure do |config|
+  # config.api_key = 'CLARIFY_API_KEY'
+  # if key in ENV
+  config.api_key = ENV['CLARIFY_API_KEY']
+end
+
+client = Clarify::Bundle.new
+
+bundle = client.create(:name => "Harvard Sentences",
+    :media_url => "http://media.clarify.io/audio/samples/harvard-sentences-1.wav")
+print bundle.data[:id]

data/lib/clarify/bundle.rb

@@ -3,31 +3,35 @@ require_relative 'request'
 module Clarify
   class Bundle < Request
 
+    def bundle_url
+        "/v#{version}/bundles"
+    end
+
     def create(query={})
-      response = self.class.post("/#{version_name}/bundles",
-                                 query: query,
+      response = self.class.post("#{bundle_url}",
+                                 body: query,
                                  headers: self.headers)
       build_response(response)
     end
 
     def find(bundle_id, args={})
       raise ArgumentError, "Missing bundle id" if bundle_id.nil?
-      response = self.class.get("/#{version_name}/bundles/#{bundle_id}", query: args, headers: headers)
+      response = self.class.get("#{bundle_url}/#{bundle_id}", query: args, headers: headers)
       build_response(response)
     end
 
     def find_all(args={})
-      response = self.class.get("/#{version_name}/bundles", headers: headers)
+      response = self.class.get("#{bundle_url}", headers: headers)
       build_response(response)
     end
 
     def delete(bundle_id)
-      response = self.class.delete("/#{version_name}/bundles/#{bundle_id}", headers: headers)
+      response = self.class.delete("#{bundle_url}/#{bundle_id}", headers: headers)
       build_response(response)
     end
 
     def update(bundle_id, query={})
-      response = self.class.put("/#{version_name}/bundles/#{bundle_id}",
+      response = self.class.put("#{bundle_url}/#{bundle_id}",
                                 body: query, headers:   headers)
       build_response(response)
     end

data/lib/clarify/request.rb

@@ -8,14 +8,14 @@ module Clarify
   class Request
     include HTTParty
     base_uri "https://api.clarify.io/"
+    version = 1
 
     #uncomment below for httparty debugging
     #debug_output
 
-    attr_accessor :version_name, :api_key
+    attr_accessor :version, :api_key
 
     def initialize
-      @version_name = Clarify.configuration.version_name
       @api_key = Clarify.configuration.api_key 
     end
 

data/lib/clarify/version.rb

@@ -1,3 +1,3 @@
 module Clarify
-  VERSION = "1.0.0"
+  VERSION = "1.1.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: clarify
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.1
 platform: ruby
 authors:
 - rubygeek
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-30 00:00:00.000000000 Z
+date: 2015-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -17,7 +17,7 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '0.13'
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 0.13.1
   type: :runtime
@@ -27,7 +27,7 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '0.13'
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 0.13.1
 - !ruby/object:Gem::Dependency
@@ -51,7 +51,7 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '10.0'
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 10.0.0
   type: :development
@@ -61,7 +61,7 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '10.0'
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 10.0.0
 - !ruby/object:Gem::Dependency
@@ -71,7 +71,7 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '3.0'
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 3.0.0
   type: :development
@@ -81,7 +81,7 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '3.0'
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 3.0.0
 - !ruby/object:Gem::Dependency
@@ -91,7 +91,7 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.6'
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.6.8
   type: :development
@@ -101,7 +101,7 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.6'
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.6.8
 description: Use the Clarify API to make your audio and video files searchable in
@@ -120,6 +120,11 @@ files:
 - README.md
 - Rakefile
 - clarify.gemspec
+- examples/create.rb
+- examples/delete.rb
+- examples/list.rb
+- examples/search.rb
+- examples/test.rb
 - lib/clarify.rb
 - lib/clarify/bundle.rb
 - lib/clarify/configuration.rb
@@ -144,17 +149,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.1
+rubygems_version: 2.4.4
 signing_key: 
 specification_version: 4
 summary: Search audio and video in a few lines of code