vagalume 0.1.1 → 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4de1924930bcaec6d295d05f8b1bcb6fe880d1a0
+  data.tar.gz: aa8b17474af99520f380b1268c2b64f53522844a
+SHA512:
+  metadata.gz: 861c5aea9ffa522caa0cef281ecb44603d7a38db42fe7d3b7babc62399fbefcef5b062bc018f6275435bde7d83cfe87a7eb42fcbeac7c7c1173bc0ec9f76200c
+  data.tar.gz: 589d8dccbd0ea44e11b55422f386e134fab06d8a305102220ccd5d7fbc9a214699b578836e0852048bd8c74442909b1f28b93aca92a7cf7f240fef3338a46f4f

data/README.md

@@ -1,45 +1,45 @@
 ## Vagalume
 
-A simple ruby interface to the Vagalume API
+A simple ruby interface to the Vagalume API. Also a command line utility to search song lyrics.
 
 ## Install
 
-You can add it to your Gemfile with:
+If you are using bundler, add it to your Gemfile:
 ```ruby
 gem 'vagalume'
 ```
-and run the bundle command to install it.
-
-For non-Rails projects, you can simply install the gem with
+or you can just install it with
 ```console
-gem install 'vagalume'
+gem install vagalume
 ```
 
 ## Usage
 
-The usage of the vagalume gem is pretty simple:
+The usage is pretty simple:
 
 ```ruby
 require "vagalume"
 
 result = Vagalume.find("Metallica", "The Unforgiven")
 
-puts result.status # Can be "exact", "aprox", "song_notfound" or "notfound"
+result.status # => Can be "exact", "aprox", "song_notfound" or "notfound"
 
-puts result.song.id
-puts result.song.name
-puts result.song.language
-puts result.song.url
-puts result.song.lyric
+song = result.song
+song.id
+song.name
+song.language
+song.url
+song.lyric
 
-puts result.artist.id
-puts result.artist.name
-puts result.artist.url
+artist = result.artist
+artist.id
+artist.name
+artist.url
 
-puts result.translations.with_language(Vagalume::Language::PORTUGUESE) # return a Song object
+result.translations.with_language(Vagalume::Language::PORTUGUESE) # return a Song object
 ```
 
-You can also use it from the command line: 
+You can also use it from the command line:
 ```console
 vagalume Metallica - The Unforgiven
 ```
@@ -48,6 +48,15 @@ or passing the [-t] flag, to show the portuguese translation:
 vagalume -t Metallica - The Unforgiven
 ```
 
+It's also pretty good at finding approximations, so you can try something like that:
+```console
+vagalume metalica - unforgiven
+```
+And everything should work fine.
+
+## Requirements
+
+Ruby >= 1.8.7
 
 ## License
 

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.1.2

data/bin/vagalume

@@ -4,11 +4,16 @@ require 'rubygems'
 require 'optparse'
 require 'vagalume'
 
+if ARGV.empty?
+  system "vagalume -h"
+  exit
+end
+
 options = {}
 optparse = OptionParser.new do |opts|
   opts.banner = "Usage: vagalume [options] [artist] - [song]"
   opts.banner += "\n    vagalume Metallica - Unforgiven"
-  opts.banner += "\n    vagalume -t Metallica - Unforgiven        Shows portuguese translation"
+  opts.banner += "\n    vagalume -t Metallica - Unforgiven        Shows portuguese translation\n\n"
 
   options[:translation] = false
   opts.on('-t', '--translation', 'Print translation') do

data/lib/vagalume/core_ext/array.rb

@@ -1,6 +1,6 @@
 class Array
   def with_language(language)
-    select { |song| song.language == language }.first
+    detect { |song| song.language == language }
   end
 end
 

data/lib/vagalume/lyric_formatter.rb

@@ -7,6 +7,7 @@ class Vagalume::LyricFormatter
       output = "\n\n"
 
       return "No lyric found" if status == Vagalume::Status::NOT_FOUND || status == Vagalume::Status::SONG_NOT_FOUND
+      return "No translation found" if translated_song.nil?
       return "\n\n#{song.name}\n\n#{song.lyric}" unless options[:translation]
 
       bigger_line = bigger_line(song.lyric)

data/lib/vagalume/search_result.rb

@@ -12,7 +12,7 @@ module Vagalume
       return result if result.status == Vagalume::Status::NOT_FOUND || result.status == Vagalume::Status::SONG_NOT_FOUND
       song = result_json["mus"].first
       artist = result_json["art"]
-      translations = song["translate"]
+      translations = song["translate"] || []
       result.song = Vagalume::Song.fetch(song)
       result.artist = Vagalume::Artist.fetch(artist)
 

data/spec/base_spec.rb

@@ -30,14 +30,14 @@ describe Vagalume do
 
   it "should return result with song not found status" do
     VCR.use_cassette('vagalume_song_not_found') do
-      result = Vagalume.find("Metallica", "Oops") 
+      result = Vagalume.find("Metallica", "Oops")
       result.status.should == Vagalume::Status::SONG_NOT_FOUND
     end
   end
 
   it "should return result with not found status" do
     VCR.use_cassette('vagalume_not_found') do
-      result = Vagalume.find("Oops", "Oops") 
+      result = Vagalume.find("Oops", "Oops")
       result.status.should == Vagalume::Status::NOT_FOUND
     end
   end

data/spec/fixtures/vcr_cassettes/vagalume_with_no_translation_available.yml

@@ -0,0 +1,81 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://www.vagalume.com.br/api/search.php?art=Bruce%20Springsteen&mus=Ain't%20good%20enough%20for%20You
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - ! '*/*'
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx
+      Content-Type:
+      - application/x-javascript; charset=UTF-8
+      Keep-Alive:
+      - timeout=60
+      Vary:
+      - Accept-Encoding
+      Expires:
+      - Sat, 14 Jul 2012 20:48:59 GMT
+      Cache-Control:
+      - max-age=30
+      Access-Control-Allow-Origin:
+      - ! '*'
+      X-Count:
+      - '10'
+      X-Powered-By:
+      - Vagalume
+      Transfer-Encoding:
+      - chunked
+      Date:
+      - Sat, 14 Jul 2012 20:48:29 GMT
+      X-Varnish:
+      - '2430257346'
+      Age:
+      - '0'
+      Via:
+      - 1.1 varnish
+      Connection:
+      - keep-alive
+    body:
+      encoding: US-ASCII
+      string: ! '{"type":"exact","art":{"id":"3ade68b5g01a8eda3","name":"Bruce Springsteen","url":"http:\/\/www.vagalume.com.br\/bruce-springsteen\/"},"mus":[{"id":"3ade68b8g567cdfa3","name":"Ain''t
+        Good Enough For You","url":"http:\/\/www.vagalume.com.br\/bruce-springsteen\/aint-good-enough-for-you.html","lang":2,"text":"Well
+        you don''t like, don''t like the way I walk\nAnd you don''t like, don''t like
+        the way I talk\nYou criticize about me endlessly\nLogic defies how you get
+        stuck with me\nAnd you complain about the clothes I wear\nAnd you explain
+        there''s other boys out there\nYou complain my car makes too much noise\nAnd
+        you cry I''m always out with the boys\n\nWhoa whoa (whoa whoa whoa whoa)\nI
+        give up little darling (whoa whoa little darling)\nYeah no matter what I do,
+        girl you know it''s true\nAin''t good enough for you\n\nYou complain the way
+        I love you at night\nYou explain I''m really not your type\nIf we go out,
+        you say I''m such a bore\nIf we stay in, you say what are we living for\nI
+        don''t understand, there''s nothing I can do\nThere ain''t no way I can satisfy
+        you\nEnd of the night I lean in for a kiss\nHere comes the pitch, a swing
+        and a miss\n\nWhoa whoa whoa whoa (whoa whoa whoa whoa)\nI quit little darling
+        (whoa whoa little darling)\nYeah no matter what I do, well you know it''s
+        true\nAin''t good enough for you, hey!\nHey!\n(Come on boys!)\n\nWhoa whoa
+        whoa whoa (whoa whoa whoa whoa)\nHey hey little darling (whoa whoa little
+        darling)\nNo matter what I do, girl you know it''s true\nAin''t good enough
+        for you\n\nI tried to change, I got a job in sales\nI bought a shirt uptown
+        in Bloomindales\nAnd babe I tried to make the latest scene\nHitting cool just
+        like Jimmy Iovine\nI bought a record with all the latest grooves\nA book of
+        love with all the latest moves\nI bought some flowers and I waited at your
+        door\nAnd you came out, didn''t want to see me no more\n\nWhoa whoa whoa (whoa
+        whoa whoa whoa)\nI quit little darling (whoa whoa little darling)\nYeah no
+        matter what I do, girl you know it''s true\nAin''t good enough for you\nHey!
+        Hey! Hey!\nNo matter what I do, girl you know it''s true\nAin''t good enough
+        for you\nAww no matter what I do, girl you know it''s true\nAin''t good enough
+        for you\nWhoaaa!"}]}'
+    http_version: 
+  recorded_at: Sat, 14 Jul 2012 20:48:29 GMT
+recorded_with: VCR 2.2.2

data/spec/lyric_formatter_spec.rb

@@ -3,23 +3,36 @@
 require "spec_helper"
 
 describe Vagalume::LyricFormatter do
-  before(:each) do
-    VCR.use_cassette('vagalume') do
-      @search = Vagalume.find("Metallica", "The Unforgiven")
+  context "there is a translation available" do
+    before(:each) do
+      VCR.use_cassette('vagalume') do
+        @search = Vagalume.find("Metallica", "The Unforgiven")
+      end
+    end
+
+    it "should format song without translation option" do
+      options = {:translation => false}
+      formatted_lyric = Vagalume::LyricFormatter.format(@search, options)
+      lyric = File.read 'spec/assets/lyric_formatter/unforgiven_lyric.txt'
+      formatted_lyric.should == lyric
     end
-  end
 
-  it "should format song without translation" do
-    options = {:translation => false}
-    formatted_lyric = Vagalume::LyricFormatter.format(@search, options)
-    lyric = File.read 'spec/assets/lyric_formatter/unforgiven_lyric.txt'
-    formatted_lyric.should == lyric
+    it "should format song with translation" do
+      options = {:translation => true}
+      formatted_lyric = Vagalume::LyricFormatter.format(@search, options)
+      lyric = File.read 'spec/assets/lyric_formatter/unforgiven_lyric_with_translation.txt'
+      formatted_lyric.should == lyric
+    end
   end
 
-  it "should format song with translation" do
-    options = {:translation => true}
-    formatted_lyric = Vagalume::LyricFormatter.format(@search, options)
-    lyric = File.read 'spec/assets/lyric_formatter/unforgiven_lyric_with_translation.txt'
-    formatted_lyric.should == lyric
+  context "there is no translation available" do
+    it "should inform user there is no translation available" do
+      VCR.use_cassette('vagalume_with_no_translation_available') do
+        @search = Vagalume.find("Bruce Springsteen", "Ain't good enough for You")
+        options = {:translation => true}
+        output = Vagalume::LyricFormatter.format(@search, options)
+        output.should == "No translation found"
+      end
+    end
   end
 end

data/vagalume.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "vagalume"
-  s.version = "0.1.1"
+  s.version = "0.1.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Brian Thomas Storti"]
-  s.date = "2012-07-12"
+  s.date = "2013-08-05"
   s.description = "Ruby interface for the Vagalume API"
   s.email = "btstorti@gmail.com"
   s.executables = ["vagalume"]
@@ -44,6 +44,7 @@ Gem::Specification.new do |s|
     "spec/fixtures/vcr_cassettes/vagalume.yml",
     "spec/fixtures/vcr_cassettes/vagalume_not_found.yml",
     "spec/fixtures/vcr_cassettes/vagalume_song_not_found.yml",
+    "spec/fixtures/vcr_cassettes/vagalume_with_no_translation_available.yml",
     "spec/lyric_formatter_spec.rb",
     "spec/spec_helper.rb",
     "vagalume.gemspec"
@@ -51,11 +52,11 @@ Gem::Specification.new do |s|
   s.homepage = "http://github.com/brianstorti/vagalume"
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
-  s.rubygems_version = "1.8.10"
+  s.rubygems_version = "2.0.3"
   s.summary = "Ruby interface for the Vagalume API"
 
   if s.respond_to? :specification_version then
-    s.specification_version = 3
+    s.specification_version = 4
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<multi_json>, [">= 0"])

metadata

@@ -1,82 +1,99 @@
 --- !ruby/object:Gem::Specification
 name: vagalume
 version: !ruby/object:Gem::Version
-  version: 0.1.1
-  prerelease: 
+  version: 0.1.2
 platform: ruby
 authors:
 - Brian Thomas Storti
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-12 00:00:00.000000000 Z
+date: 2013-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
-  requirement: &2153482760 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2153482760
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &2153482260 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 1.8.4
   type: :development
   prerelease: false
-  version_requirements: *2153482260
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.4
 - !ruby/object:Gem::Dependency
   name: vcr
-  requirement: &2153481700 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2153481700
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2153480760 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2153480760
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: webmock
-  requirement: &2153479720 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2153479720
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: multi_json
-  requirement: &2153478860 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2153478860
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Ruby interface for the Vagalume API
 email: btstorti@gmail.com
 executables:
@@ -112,35 +129,32 @@ files:
 - spec/fixtures/vcr_cassettes/vagalume.yml
 - spec/fixtures/vcr_cassettes/vagalume_not_found.yml
 - spec/fixtures/vcr_cassettes/vagalume_song_not_found.yml
+- spec/fixtures/vcr_cassettes/vagalume_with_no_translation_available.yml
 - spec/lyric_formatter_spec.rb
 - spec/spec_helper.rb
 - vagalume.gemspec
 homepage: http://github.com/brianstorti/vagalume
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -2214619298880552595
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Ruby interface for the Vagalume API
 test_files: []