echonest-ruby-api 0.0.4 → 0.0.5

data/lib/base.rb

@@ -1,7 +1,6 @@
 require 'artist'
 require 'biography'
 require 'blog'
-require 'news'
 
 module Echonest
   class Base
@@ -12,14 +11,33 @@ module Echonest
       @base_uri = "http://developer.echonest.com/api/v4/"
     end
 
+    # Gets the base URI for all API calls
+    #
+    # Returns a String
     def self.base_uri
       "http://developer.echonest.com/api/v#{ Base.version }/"
     end
 
+    # The current version of the Echonest API to be supported.
+    #
+    # Returns a Fixnum
     def self.version
       4
     end
 
+    # Performs a simple HTTP get on an API endpoint.
+    #
+    # Examples:
+    #     get('artist/biographies', results: 10)
+    #     #=> Array of Biography objects.
+    #
+    # Raises an +ArgumentError+ if the Echonest API responds with
+    # an error.
+    #
+    # * +endpoint+ - The name of an API endpoint as a String
+    # * +options+ - A Hash of options to pass to the end point.
+    #
+    # Returns a response as a Hash
     def get(endpoint, options = {})
       query_string = ""
       options.each do |key, value|

data/lib/echonest-ruby-api/version.rb

@@ -1,3 +1,3 @@
 module Echonest
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: echonest-ruby-api
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-09 00:00:00.000000000 Z
+date: 2013-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -105,17 +105,36 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- doc/Biography.html
+- doc/Blog.html
+- doc/Echonest.html
+- doc/Echonest/Artist.html
+- doc/Echonest/Base.html
+- doc/Echonest/Base/EchonestConnectionError.html
+- doc/_index.html
+- doc/class_list.html
+- doc/css/common.css
+- doc/css/full_list.css
+- doc/css/style.css
+- doc/file.README.html
+- doc/file_list.html
+- doc/frames.html
+- doc/index.html
+- doc/js/app.js
+- doc/js/full_list.js
+- doc/js/jquery.js
+- doc/method_list.html
+- doc/top-level-namespace.html
 - echonest-ruby-api.gemspec
 - lib/artist.rb
 - lib/base.rb
 - lib/biography.rb
 - lib/blog.rb
 - lib/echonest-ruby-api.rb
-- lib/echonest-ruby-api/news.rb
 - lib/echonest-ruby-api/version.rb
-- lib/news.rb
 - pkg/echonest-ruby-api-0.0.1.gem
 - pkg/echonest-ruby-api-0.0.3.gem
+- pkg/echonest-ruby-api-0.0.4.gem
 - spec/artist_spec.rb
 - spec/base_spec.rb
 - spec/spec_helper.rb
@@ -148,3 +167,4 @@ test_files:
 - spec/artist_spec.rb
 - spec/base_spec.rb
 - spec/spec_helper.rb
+has_rdoc: 

data/lib/echonest-ruby-api/news.rb

@@ -1,26 +0,0 @@
-class News
-
-  def initialize(options = {})
-    @name = options[:name]
-    @url = options[:url]
-    @date_posted = options[:date_posted]
-    @summary = options[:summary]
-  end
-
-  def name
-    @name
-  end
-
-  def url
-    @url
-  end
-
-  def date_posted
-    @date_posted
-  end
-
-  def summary
-    @summary
-  end
-
-end

data/lib/news.rb

@@ -1,4 +0,0 @@
-module Echonest
-  class News
-  end
-end