lyriki 1.0.0 → 1.0.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 737cc120be682e468db5d479867c38041e42e0b7
-  data.tar.gz: 8b7dc7f4911f6df1a55baa9626ec5ace7cb82c78
+  metadata.gz: 115c12b55ce53c2fdd9b97adcf14c0935ba66b72
+  data.tar.gz: 5d9c1dfbff46b1546109d257bc15a54024efb337
 SHA512:
-  metadata.gz: 0e41f0ae5d331fca05b4445e281abf0f4fe3b38ba572dca2a2421677e24c509270d95ee5a2555e1dca518c619b694144a1471936e9a806202ae45b8a92175b28
-  data.tar.gz: 07d961aa02ecfcd26bcfa62a6853ee4be3c27a28e0c4b449a171894ac6f6b4949e22eebae4e2b339f10c832b3843e3347ff7784bf6e30e4ccab0555ac3a511d8
+  metadata.gz: 819cb348a07c2c843f1b3621752e0e783592fb82191fc6fb9de5bdd3d45fd0e7aea658ed8564ea322abf2d4a7bcd6c3e3724d3dfa61d851aa696b3135c97157d
+  data.tar.gz: e33132e3b6ac3337e5173a9de053696a8800fac54d957c32da50204d211c8720db684849d57d59b080f60b5a4e6fd619715236667a8b19c9a5f22bbdb121ac98

data/.gitignore

@@ -1,2 +1,3 @@
 /pkg/
 *.gem
+Gemfile.lock

data/README.md

@@ -1,5 +1,8 @@
-# lyriki: wrapper for [LyricsWiki](http://lyrics.wikia.com)'s [API](http://lyrics.wikia.com/LyricWiki:API)
+# lyriki
 
+A [Ruby gem](http://rubygems.org/gems/lyriki) wrapper for [LyricsWiki](http://lyrics.wikia.com)'s [API](http://lyrics.wikia.com/LyricWiki:API).
+
+[![Gem Version](https://badge.fury.io/rb/lyriki.svg)](http://badge.fury.io/rb/lyriki)
 [![Build Status](https://travis-ci.org/alxndr/lyriki.png?branch=master)](https://travis-ci.org/alxndr/lyriki)
 [![Code Climate](https://codeclimate.com/github/alxndr/lyriki.png)](https://codeclimate.com/github/alxndr/lyriki)
 [![Test Coverage](https://codeclimate.com/github/alxndr/lyriki/badges/coverage.svg)](https://codeclimate.com/github/alxndr/lyriki)

data/Rakefile

@@ -1,2 +1,8 @@
 require "bundler/gem_tasks"
+require "rspec/core/rake_task"
 
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.rspec_opts = ["--color", "--format documentation"]
+end
+
+task default: :spec

data/lib/custom_string_methods.rb

@@ -0,0 +1,7 @@
+module CustomStringMethods
+
+  def url_encode
+    CGI.escape self
+  end
+
+end

data/lib/lyriki/legacy/artist_data.rb

@@ -8,7 +8,7 @@ module Lyriki
       include WebHelpers
 
       def initialize(name)
-        @data = get url_for_artist(name)
+        @data = get(url_for_artist(name))
       end
 
       def response_data
@@ -18,7 +18,7 @@ module Lyriki
       private
 
       def url_for_artist(name)
-        "http://lyrics.wikia.com/api.php?func=getArtist&artist=#{url_encode(name)}&fmt=realjson"
+        "http://lyrics.wikia.com/api.php?func=getArtist&artist=#{name.url_encode}&fmt=realjson"
       end
 
     end

data/lib/lyriki/legacy/song_data.rb

@@ -9,7 +9,7 @@ module Lyriki
 
       def initialize(**args)
         raise ArgumentError unless args[:artist] && args[:song]
-        @data = get url_for_song(args[:artist], args[:song])
+        @data = get(url_for_song(args[:artist], args[:song]))
       end
 
       def response_data
@@ -19,7 +19,7 @@ module Lyriki
       private
 
       def url_for_song(artist, song)
-        "http://lyrics.wikia.com/api.php?artist=#{url_encode(artist)}&song=#{url_encode(song)}&fmt=realjson"
+        "http://lyrics.wikia.com/api.php?artist=#{artist.url_encode}&song=#{song.url_encode}&fmt=realjson"
       end
 
     end

data/lib/lyriki/version.rb

@@ -1,3 +1,3 @@
 module Lyriki
-  VERSION = "1.0.0"
+  VERSION = "1.0.0.1"
 end

data/lib/web_helpers.rb

@@ -1,11 +1,13 @@
-module WebHelpers
+require "custom_string_methods"
 
-  def url_encode(str)
-    CGI.escape str
-  end
+module WebHelpers
 
   def get(url)
     Net::HTTP.get URI(url)
   end
 
+  String.instance_eval do
+    include CustomStringMethods
+  end
+
 end

data/lyriki.gemspec

@@ -9,7 +9,11 @@ Gem::Specification.new do |s|
   s.authors       = ["Alexander"]
   s.email         = ["alxndr+gem@gmail.com"]
   s.summary       = "A wrapper for the LyricsWiki API"
-  s.description   = "A basic Ruby wrapper for the API provided by LyricsWiki (http://lyrics.wikia.com/)."
+  s.description   = <<-DESC
+    A basic Ruby wrapper for the API provided by LyricsWiki (http://lyrics.wikia.com/).
+
+    Currently only implements fetching artist data, song data, and song lyrics.
+  DESC
   s.homepage      = "http://github.com/alxndr/lyriki"
   s.license       = "MIT"
 
@@ -18,9 +22,14 @@ Gem::Specification.new do |s|
   s.test_files    = s.files.grep(%r{^spec/})
   s.require_paths = ["lib"]
 
+  s.required_ruby_version = ">= 2.0"
+
   s.add_runtime_dependency "json"
   s.add_runtime_dependency "nokogiri"
 
   s.add_development_dependency "bundler", "~> 1.6"
   s.add_development_dependency "rake"
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "vcr"
+  s.add_development_dependency "webmock"
 end

data/spec/custom_string_methods_spec.rb

@@ -0,0 +1,22 @@
+require "spec_helper"
+
+describe CustomStringMethods do
+
+  String.instance_eval do
+    include CustomStringMethods
+  end
+
+  describe "#url_encode" do
+    it "should replace troublesome characters" do
+      encoded = "foo's bar & baz".url_encode
+
+      expect(encoded).not_to include " "
+      expect(encoded).to include "+"
+      expect(encoded).not_to include "'"
+      expect(encoded).to include "%27"
+      expect(encoded).not_to include "&"
+      expect(encoded).to include "%26"
+    end
+  end
+
+end

data/spec/lyriki/legacy/song_lyrics_spec.rb

@@ -20,7 +20,7 @@ describe Lyriki::Legacy::SongLyrics, vcr: { record: :none } do
   describe "initialize" do
     describe "without an artist" do
       it "should raise an error" do
-        expect{ Lyriki::Legacy::SongLyrics.new song: "inca roads" }.to raise_error(ArgumentError)
+        expect { Lyriki::Legacy::SongLyrics.new song: "inca roads" }.to raise_error(ArgumentError)
       end
     end
     describe "without a song" do

data/spec/web_helpers_spec.rb

@@ -5,15 +5,6 @@ describe WebHelpers do
 
   subject { Class.new { include WebHelpers }.new }
 
-  describe "#url_encode" do
-    it "should replace apostrophes" do
-      encoded = subject.url_encode("foo's bar")
-
-      expect(encoded).not_to include "'"
-      expect(encoded).to include "%27"
-    end
-  end
-
   describe "#get" do
     it { is_expected.to respond_to :get }
     it "should hit Net::HTTP"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lyriki
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.0.1
 platform: ruby
 authors:
 - Alexander
@@ -66,7 +66,52 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: A basic Ruby wrapper for the API provided by LyricsWiki (http://lyrics.wikia.com/).
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |2
+      A basic Ruby wrapper for the API provided by LyricsWiki (http://lyrics.wikia.com/).
+
+      Currently only implements fetching artist data, song data, and song lyrics.
 email:
 - alxndr+gem@gmail.com
 executables: []
@@ -77,12 +122,12 @@ files:
 - ".hound.yml"
 - ".travis.yml"
 - Gemfile
-- Gemfile.lock
 - Guardfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - config/rubocop.yml
+- lib/custom_string_methods.rb
 - lib/lyriki.rb
 - lib/lyriki/legacy.rb
 - lib/lyriki/legacy/artist_data.rb
@@ -91,6 +136,7 @@ files:
 - lib/lyriki/version.rb
 - lib/web_helpers.rb
 - lyriki.gemspec
+- spec/custom_string_methods_spec.rb
 - spec/fixtures/vcr_cassettes/Lyriki_Legacy_ArtistData/.yml
 - spec/fixtures/vcr_cassettes/Lyriki_Legacy_ArtistData/_response_data/should_return_stored_data.yml
 - spec/fixtures/vcr_cassettes/Lyriki_Legacy_SongData/.yml
@@ -116,7 +162,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -129,6 +175,7 @@ signing_key:
 specification_version: 4
 summary: A wrapper for the LyricsWiki API
 test_files:
+- spec/custom_string_methods_spec.rb
 - spec/fixtures/vcr_cassettes/Lyriki_Legacy_ArtistData/.yml
 - spec/fixtures/vcr_cassettes/Lyriki_Legacy_ArtistData/_response_data/should_return_stored_data.yml
 - spec/fixtures/vcr_cassettes/Lyriki_Legacy_SongData/.yml

data/Gemfile.lock

@@ -1,93 +0,0 @@
-PATH
-  remote: .
-  specs:
-    lyriki (0.0.1)
-      json
-      nokogiri
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    addressable (2.3.6)
-    awesome_print (1.2.0)
-    celluloid (0.16.0)
-      timers (~> 4.0.0)
-    codeclimate-test-reporter (0.4.1)
-      simplecov (>= 0.7.1, < 1.0.0)
-    coderay (1.1.0)
-    crack (0.4.2)
-      safe_yaml (~> 1.0.0)
-    diff-lcs (1.2.5)
-    docile (1.1.5)
-    ffi (1.9.6)
-    formatador (0.2.5)
-    guard (2.9.1)
-      formatador (>= 0.2.4)
-      listen (~> 2.7)
-      lumberjack (~> 1.0)
-      pry (>= 0.9.12)
-      thor (>= 0.18.1)
-    guard-rspec (4.3.1)
-      guard (~> 2.1)
-      rspec (>= 2.14, < 4.0)
-    hitimes (1.2.2)
-    json (1.8.1)
-    listen (2.8.3)
-      celluloid (>= 0.15.2)
-      rb-fsevent (>= 0.9.3)
-      rb-inotify (>= 0.9)
-    lumberjack (1.0.9)
-    method_source (0.8.2)
-    mini_portile (0.6.1)
-    multi_json (1.10.1)
-    nokogiri (1.6.4.1)
-      mini_portile (~> 0.6.0)
-    pry (0.10.1)
-      coderay (~> 1.1.0)
-      method_source (~> 0.8.1)
-      slop (~> 3.4)
-    rake (10.4.0)
-    rb-fsevent (0.9.4)
-    rb-inotify (0.9.5)
-      ffi (>= 0.5.0)
-    rspec (3.1.0)
-      rspec-core (~> 3.1.0)
-      rspec-expectations (~> 3.1.0)
-      rspec-mocks (~> 3.1.0)
-    rspec-core (3.1.7)
-      rspec-support (~> 3.1.0)
-    rspec-expectations (3.1.2)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.1.0)
-    rspec-mocks (3.1.3)
-      rspec-support (~> 3.1.0)
-    rspec-support (3.1.2)
-    safe_yaml (1.0.4)
-    simplecov (0.9.1)
-      docile (~> 1.1.0)
-      multi_json (~> 1.0)
-      simplecov-html (~> 0.8.0)
-    simplecov-html (0.8.0)
-    slop (3.6.0)
-    thor (0.19.1)
-    timers (4.0.1)
-      hitimes
-    vcr (2.9.3)
-    webmock (1.20.4)
-      addressable (>= 2.3.6)
-      crack (>= 0.3.2)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  awesome_print
-  bundler (~> 1.6)
-  codeclimate-test-reporter
-  guard
-  guard-rspec
-  lyriki!
-  rake
-  rspec
-  vcr
-  webmock