phish_dot_net_client 0.1.0 → 0.1.1

data/History.md

@@ -1,3 +1,9 @@
+### 0.1.1 / 2013-10-28
+
+* Make readme better formatted
+* Clean some more stuff up
+
+
 ### 0.1.0 / 2013-10-28
 
 * Add code documentation

data/README.md

@@ -4,8 +4,6 @@
 
 A Phish.net API client, with support for parsing the 'setlistdata' field. Inspired by the other Ruby Phish.net API [client](http://api.phish.net/wrappers/ruby.php) written by [Stephen Blackstone](http://phish.net/user/steveb3210).
 
-[rdoc](http://rubydoc.info/github/alexebird/phish_dot_net_client/master/frames/file/README.md)
-
 
 ## Install
 
@@ -24,21 +22,21 @@ Rubygems:
     PhishDotNetClient.apikey = 'private-api-key'
     PhishDotNetClient.authorize 'fluffhead', 'passwurd'
     PhishDotNetClient.clear_auth  # clears the stored apikey, username, and authkey
-
+    
     # Call API methods by replacing '.' with '_' in the method name
     PhishDotNetClient.pnet_shows_setlists_latest
-
+    
     # The 'pnet_' prefix is optional
     PhishDotNetClient.shows_setlists_latest
-
+    
     # Pass arguments to the API call with a hash
     PhishDotNetClient.shows_setlists_get :showdate => '2013-07-31'
     PhishDotNetClient.shows_query :month => '7', :country => 'USA', :state => 'CA'
-
+    
     # Arguments are not checked for validity before being passed
     PhishDotNetClient.shows_setlists_get :fluff => 'head'
     # => returns {"success" => 0,"reason" => "General API Error"}
-
+    
     # All methods return JSON parsed into Ruby Hashes/Arrays
     tweez = PhishDotNetClient.shows_setlists_get :showdate => '2013-07-31'
     # => [
@@ -46,15 +44,23 @@ Rubygems:
     #        "showdate" => "2013-07-31",
     #            "city" => "Stateline",
     #           "state" => "NV",
-    #     "setlistdata" => #<PhishDotNetClient::Setlist ...>
+    #     "setlistdata" => #<PhishDotNetClient::Setlist ...>, ... }, ... ]
+    
+    tweez.first["showdate"]
+    # => "2013-07-31"
 
 See [Phish.net API docs](http://api.phish.net/docu/) for available API methods.
 
 
-### setlistdata Parsing
+### Parsing setlistdata
 
-JSON objects that have a "setlistdata" will have that field parsed and replaced with
-a [Setlist](http://rubydoc.info/github/alexebird/phish_dot_net_client/master/PhishDotNetClient/Setlist) object. See rdoc for how to use the parsed setlist.
+JSON objects that have a "setlistdata" field will have that field parsed and replaced with
+a [Setlist](http://rubydoc.info/github/alexebird/phish_dot_net_client/master/PhishDotNetClient/Setlist) object.
+
+
+## Docs
+
+Check out the [documentation](http://rubydoc.info/github/alexebird/phish_dot_net_client/master/frames/file/README.md).
 
 
 ## Known Issues
@@ -62,7 +68,6 @@ a [Setlist](http://rubydoc.info/github/alexebird/phish_dot_net_client/master/Phi
 - Song titles with a ',' character don't get parsed correctly due to the ',' being interpreted as a boundary between song titles. See lib/phish_dot_net_client/setlist.rb#133 for the regex and parsing code.
 
 
-
 ## Testing
 
 To run specs:
@@ -70,4 +75,3 @@ To run specs:
     bundle exec rake spec
 
 Pull requests are welcome!
-

data/Rakefile

@@ -52,7 +52,7 @@ task :"release:instructions" do
   puts "1. update version.rb"
   puts "2. update History.md"
   puts "       git log #{last_release}..HEAD --no-merges --format=%B"
-  puts "3. git commit, git tag v#{version}, git push origin v#{version}"
+  puts "3. git commit -am 'v#{version}', git tag v#{version}, git push origin v#{version}"
   puts "4. gem build #{gem_name}.gemspec ; mv #{gem_name}-#{version}.gem ~/gems/"
   puts "5. gem push ~/gems/#{gem_name}-#{version}.gem"
 end

data/lib/phish_dot_net_client.rb

@@ -57,8 +57,9 @@ module PhishDotNetClient
   # The base URL for API calls
   BASE_URL = "https://api.phish.net/api.js"
 
-  # "https://api.phish.net/api.js?api=2.0&method=pnet.shows.query&format=json&apikey=920FF765772E442F3E22&year=2011"
+  # "https://api.phish.net/api.js?api=2.0&method=pnet.shows.query&format=json&apikey=XXX&year=2011"
 
+  # Default API parameters
   DEFAULT_PARAMS = { api: "2.0",
                   format: "json" }
 

data/lib/phish_dot_net_client/version.rb

@@ -3,5 +3,5 @@
 module PhishDotNetClient
 
   # Gem version
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Alexander Bird