clarify 1.1.1 → 2.0.0.alpha.1

data/LICENSE.txt

@@ -1,24 +0,0 @@
-Copyright (c) 2014 Clarify, Inc.
-
-Written by Nola Stowe @rubygeek
-
-MIT License
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/examples/create.rb

@@ -1,14 +0,0 @@
-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

@@ -1,12 +0,0 @@
-
-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

@@ -1,14 +0,0 @@
-
-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

@@ -1,26 +0,0 @@
-
-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

@@ -1,15 +0,0 @@
-
-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

@@ -1,40 +0,0 @@
-require_relative 'request'
-
-module Clarify
-  class Bundle < Request
-
-    def bundle_url
-        "/v#{version}/bundles"
-    end
-
-    def create(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("#{bundle_url}/#{bundle_id}", query: args, headers: headers)
-      build_response(response)
-    end
-
-    def find_all(args={})
-      response = self.class.get("#{bundle_url}", headers: headers)
-      build_response(response)
-    end
-
-    def delete(bundle_id)
-      response = self.class.delete("#{bundle_url}/#{bundle_id}", headers: headers)
-      build_response(response)
-    end
-
-    def update(bundle_id, query={})
-      response = self.class.put("#{bundle_url}/#{bundle_id}",
-                                body: query, headers:   headers)
-      build_response(response)
-    end
-
-  end
-end

data/lib/clarify/metadata.rb

@@ -1,26 +0,0 @@
-require_relative 'request'
-
-module Clarify
-  class Metadata < Request
-
-    def find(bundle_id)
-      raise ArgumentError, "Missing bundle id" if bundle_id.nil?
-      response = self.class.get("/#{version_name}/bundles/#{bundle_id}/metadata", headers: headers)
-      build_response(response)
-    end
-
-    def delete(bundle_id)
-      raise ArgumentError, "Missing bundle id" if bundle_id.nil?
-      response = self.class.delete("/#{version_name}/bundles/#{bundle_id}/metadata", headers: headers)
-      build_response(response)
-    end
-
-    def update(bundle_id, data="")
-      raise ArgumentError, "Missing bundle id" if bundle_id.nil?      
-      response = self.class.put("/#{version_name}/bundles/#{bundle_id}/metadata",
-                                body: {data: data} , headers: headers)
-      build_response(response)
-    end
-
-  end
-end

data/lib/clarify/request.rb

@@ -1,37 +0,0 @@
-require 'httparty'
-require 'json'
-
-module Clarify
-
-  Response = Struct.new(:status, :data)
-
-  class Request
-    include HTTParty
-    base_uri "https://api.clarify.io/"
-    version = 1
-
-    #uncomment below for httparty debugging
-    #debug_output
-
-    attr_accessor :version, :api_key
-
-    def initialize
-      @api_key = Clarify.configuration.api_key 
-    end
-
-    def headers
-      {"Authorization" => "Bearer #{@api_key}",
-       "User-Agent" => "clarify-gem/#{Clarify::VERSION}/#{Gem.ruby_version.version}"}
-    end
-
-    def build_response(response)
-      if response.code != 204  #http code for no content
-        body = JSON.parse(response.parsed_response, symbolize_names: true)
-      else
-        body = "" 
-      end
-      Response.new(response.code, body)
-    end
-  end
-end
-

data/lib/clarify/search.rb

@@ -1,10 +0,0 @@
-module Clarify
-  class Search < Request
-
-    def perform(query={})
-      response = self.class.get("/#{version_name}/search", query: query, headers: headers)
-      build_response(response)
-    end
-    
-  end
-end

data/lib/clarify/track.rb

@@ -1,40 +0,0 @@
-require_relative 'request'
-
-module Clarify
-  class Track < Request
-
-    def all(bundle_id)
-      raise ArgumentError, "Missing bundle id" if bundle_id.nil?
-      response = self.class.get("/#{version_name}/bundles/#{bundle_id}/tracks", headers: headers)
-      build_response(response)
-    end
-
-    def add(bundle_id, media_url) 
-      raise ArgumentError, "Missing bundle id" if bundle_id.nil?
-      raise ArgumentError, "Missing media_url" if media_url.nil?
-      response = self.class.post("/#{version_name}/bundles/#{bundle_id}/tracks", body: {media_url: media_url}, headers: headers)
-      build_response(response)  
-    end
-
-    def delete(bundle_id, track="")
-      raise ArgumentError, "Missing bundle id" if bundle_id.nil?
-      response = self.class.delete("/#{version_name}/bundles/#{bundle_id}/tracks", query: {track: track}, headers: headers)
-      build_response(response)  
-    end
-
-    def delete_by_id(bundle_id, track_id)
-      raise ArgumentError, "Missing bundle id" if bundle_id.nil?
-      raise ArgumentError, "Missing track id" if track_id.nil?
-      response = self.class.delete("/#{version_name}/bundles/#{bundle_id}/tracks/#{track_id}", headers: headers)
-      build_response(response)  
-    end
-
-    def find(bundle_id, track_id)
-      raise ArgumentError, "Missing bundle id" if bundle_id.nil?
-      raise ArgumentError, "Missing track id" if track_id.nil?
-      response = self.class.get("/#{version_name}/bundles/#{bundle_id}/tracks/#{track_id}", headers: headers)
-      build_response(response)    
-    end
-
-  end
-end

data/spec/lib/clarify/bundle_spec.rb

@@ -1,43 +0,0 @@
-module Clarify
-
- describe Bundle do
-   before do
-     @response = Bundle.new.create
-     @bundle_id = @response.data[:id]
-   end
-
-   after do
-     Bundle.new.delete(@bundle_id)
-   end
-
-   it "should create a new bundle with all blank values" do
-     expect(@response.data).to include(:_class, :_links, :id) 
-   end
-    
-   it "should retrieve the bundle created" do
-     response = Bundle.new.find(@bundle_id)
-     expect(response.status).to eql 200
-   end
-
-   it "should find all bundles" do
-     response = Bundle.new.find_all
-     expect(response.status).to eql 200
-    end
-
-    it "should update a bundle" do
-      response = Bundle.new.update(@bundle_id, {name: "test"})
-      expect(response.status).to eql 202
-      expect(response.data.keys).to include(:_class, :_links, :id)
-    end
-  end
-
-  context "deleting a bundle" do
-    it "should delete the bundle" do
-      response = Bundle.new.create
-      Bundle.new.delete(response.data[:id])
-      expect(Bundle.new.find(response.data[:id]).status).to be 404
-    end
-  end
-
-end
-

data/spec/lib/clarify/configuration_spec.rb

@@ -1,19 +0,0 @@
-module Clarify
-  describe Config do
-    before do 
-      Clarify.configure do |config|
-        config.api_key = ENV['CLARIFY_API_KEY']
-        config.version = 5
-      end
-    end
-
-    it "should set the api_key in configuration" do
-      expect(Request.new.api_key).to eql(ENV['CLARIFY_API_KEY'])
-    end
-
-    it "should set the version number in the configuration" do
-      expect(Request.new.version_name).to eql("v5") 
-    end
-  end
-end
-

data/spec/lib/clarify/metadata_spec.rb

@@ -1,36 +0,0 @@
-module Clarify
-
-  describe Metadata do
-    before do
-      bundle = Bundle.new.create
-      @bundle_id = bundle.data[:id]
-    end
-
-    after do
-      Bundle.new.delete(@bundle_id)
-    end
-    
-    it "should retrieve the metadata for bundle" do
-      metadata = Metadata.new.find(@bundle_id)
-      expect(metadata.status).to eql 200
-    end
-
-    it "should update a bundle" do
-      metadata = Metadata.new.update(@bundle_id, '{"meta": 1}')
-      expect(metadata.status).to eql 202
-      expect(metadata.data.keys).to include(:_class, :_links)
-    end
-
-    it "should delete the metadata" do
-      Metadata.new.update(@bundle_id, '{"meta": 1}')
-      metadata_before  = Metadata.new.find(@bundle_id)         
-      expect(metadata_before.data[:data].keys).to include :meta
-
-      metadata_after = Metadata.new.delete(@bundle_id)
-      expect(metadata_after.status).to eq 204
-      expect(metadata_after.data).to be_empty
-    end
-  end
-
-end
-

data/spec/lib/clarify/search_spec.rb

@@ -1,22 +0,0 @@
-module Clarify
-
-  describe Search do
-    before do
-      @response = Bundle.new.create
-      @bundle_id = @response.data[:id]
-      @media_url = "http://media.clarify.io/audio/samples/harvard-sentences-1.wav"
-      @response = Track.new.add(@bundle_id, @media_url)
-    end
-
-   after do
-     Bundle.new.delete(@bundle_id)
-   end
-
-    it "should search for a word in speech" do
-      response = Search.new.perform({query: "cat"})
-      expect(response.data[:item_results].first[:term_results].first[:matches].first[:hits].size).to eql 2  
-    end
-  end
-
-end
-

data/spec/lib/clarify/track_spec.rb

@@ -1,81 +0,0 @@
-module Clarify
-
-  describe Track do 
-
-    before do
-      bundle = Bundle.new.create
-      @bundle_id = bundle.data[:id]
-    end
-
-    after do
-      Bundle.new.delete(@bundle_id)
-    end
-
-    context "adding tracks and getting tracks for bundle" do
-      before do
-        @media_url = "http://media.clarify.io/audio/samples/harvard-sentences-1.wav"
-        @response = Track.new.add(@bundle_id, @media_url)
-      end
-      it "should be successful" do
-        expect(@response.status).to eql 201
-        expect(@response.data.keys).to include(:_class, :_links)
-      end
-      it "should list track in bundle" do
-        response = Track.new.all(@bundle_id)
-        expect(response.data[:tracks]).to be_an_instance_of(Array)
-        expect(response.data[:tracks][0][:media_url]).to eql @media_url
-      end    
-    end
-
-    context "adding a track and deleting all tracks for bundle" do
-      before do
-        @media_url = "http://media.clarify.io/audio/samples/harvard-sentences-1.wav"
-        @add_response = Track.new.add(@bundle_id, @media_url)
-        @del_response = Track.new.delete(@bundle_id)
-      end
-      it "should be successful" do
-        expect(@del_response.status).to eql 204
-      end
-      it "should not be in bundle" do
-        response = Track.new.all(@bundle_id)
-        expect(response.data[:tracks]).to be_empty
-      end    
-    end
-
-    context "adding a track and finding by track_id" do
-      before do
-        media_url = "http://media.clarify.io/audio/samples/harvard-sentences-1.wav"
-        Track.new.add(@bundle_id, media_url)
-
-        all_tracks = Track.new.all(@bundle_id)
-        
-        @track_id = all_tracks.data[:tracks].first[:id]
-        @find_response = Track.new.find(@bundle_id, @track_id)
-      end
-      it "should be successful" do
-        expect(@find_response.status).to eql 200
-      end
-      it "should have some keys and duration value" do
-        expect(@find_response.data.keys).to include(:audio_channel,:audio_language, :duration)
-        expect(@find_response.data[:duration]).to eql  64.422875
-      end
-    end
-
-    context "adding a track and deleting by delete_by_id  " do
-      before do
-        media_url = "http://media.clarify.io/audio/samples/harvard-sentences-1.wav"
-        Track.new.add(@bundle_id, media_url)
-
-        all_tracks = Track.new.all(@bundle_id)
-        
-        @track_id = all_tracks.data[:tracks].first[:id]
-        @find_response = Track.new.delete_by_id(@bundle_id, @track_id)
-      end
-      it "should be successful" do
-        expect(@find_response.status).to eql 204
-      end
-    end
-  end
-
-end
-