hypem 0.0.3 → 0.1.0

data/README.md

@@ -15,39 +15,41 @@ This is an unoffical Ruby gem for the **Hype Machine** read-only API. It support
 
 - `Hypem.playlist.tags('tag_name,electro,indie')` --- tracks matching given comma-delimited tags. *The API warns against combining too many different tags*
 
+- `Hypem.playlist.create_url([hypem_track1,hypem_track2])` --- create a custom Hypem-based playlist URL using array of `Hypem::Track`'s
+
 - `Hypem.playlist.popular` --- the most popular tracks over a certain timeframe or set. It accepts one of the following arguments:
 
 
-<table>
-  <thead>
-    <tr>
-      <th> Argument </th>
-      <th> Response (Most Popular...) </th>
-    </tr>
-  </thead>
-  <tbody>
-    <tr>
-      <td><code>'3day'</code> <em>default</em></td>
-      <td>tracks over the last 3 days</td>
-    </tr>
-    <tr>
-      <td><code>:lastweek</code></td>
-      <td>tracks over the last 7 days</td>
-    </tr>
-    <tr>
-      <td><code>:noremix</code></td>
-      <td>non-remixed tracks, over last 3 days</td>
-    </tr>
-    <tr>
-      <td><code>:artists</code></td>
-      <td>tracks by most-blogged artists over last 3 days</td>
-    </tr>
-    <tr>
-      <td><code>:twitter</code></td>
-      <td>tweeted tracks over last 3 days</td>
-    </tr>
-  </tbody>
-</table>
+      <table>
+        <thead>
+          <tr>
+            <th> Argument </th>
+            <th> Response (Most Popular...) </th>
+          </tr>
+        </thead>
+        <tbody>
+          <tr>
+            <td><code>'3day'</code> <em>default</em></td>
+            <td>tracks over the last 3 days</td>
+          </tr>
+          <tr>
+            <td><code>:lastweek</code></td>
+            <td>tracks over the last 7 days</td>
+          </tr>
+          <tr>
+            <td><code>:noremix</code></td>
+            <td>non-remixed tracks, over last 3 days</td>
+          </tr>
+          <tr>
+            <td><code>:artists</code></td>
+            <td>tracks by most-blogged artists over last 3 days</td>
+          </tr>
+          <tr>
+            <td><code>:twitter</code></td>
+            <td>tweeted tracks over last 3 days</td>
+          </tr>
+        </tbody>
+      </table>
 
 Each playlist has a `tracks` attribute containing an array of `Hypem::Tracks`'s. Pagination is supported with the `.next_page` and `.prev_page` methods.
 
@@ -65,15 +67,15 @@ Users can be accessed via `Hypem.user('username')` and have various methods:
 #### Playlist Methods ####
 `Hypem::User` offers several methods for accessing a particular user's personalized playlists:
 
-- `user.loved_playlist` --- a user's loved tracks
+  - `user.loved_playlist` --- a user's loved tracks
 
-- `user.obsessed_playlist` --- a user's obsessed tracks
+  - `user.obsessed_playlist` --- a user's obsessed tracks
 
-- `user.feed_playlist` --- a user's tracks from all followed entities
+  - `user.feed_playlist` --- a user's tracks from all followed entities
 
-- `user.friends_favorites_playlist` --- a user's friends' favorited tracks
+  - `user.friends_favorites_playlist` --- a user's friends' favorited tracks
 
-- `user.friends_history_playlist` --- tracks from a user's friends' listening histories
+  - `user.friends_history_playlist` --- tracks from a user's friends' listening histories
 
 ******
 
@@ -85,7 +87,7 @@ Blogs can be retrieved using a blog's unique id via `Hypem.blog(1234)` and has t
 ******
 
 ### Track ###
-All Playlist objects have a `tracks` attribute containing an array of `Hypem::Track`s. A sample object inspect is as follows:
+All Playlist objects have a `tracks` attribute containing an array of `Hypem::Track`'s. A sample object inspect is as follows:
 
       #<Hypem::Track
         artist="Hot Chip"

data/lib/hypem/playlist.rb

@@ -2,18 +2,18 @@ module Hypem
   class Playlist
     POPULAR_ARGS = [%s(3day),:lastweek,:noremix,:artists,:twitter]
     GENERIC_METHODS = [:blog, :tags, :search, :artist, :feed, :loved, :obsessed]
-    attr_accessor :url, :tracks
+    attr_accessor :path, :tracks
     attr_reader :extended
 
     def initialize(type,arg,page=1)
       @type = type
       @arg = arg
       @page = page
-      @url = "/playlist/#{@type}/#{@arg}/json/#{@page}"
+      @path = "/playlist/#{@type}/#{@arg}/json/#{@page}"
     end
 
     def get
-      response = Request.new(url).get.response
+      response = Request.new(@path).get.response
       @tracks = []
       # getting rid of version cell
       response.body.shift
@@ -29,6 +29,13 @@ module Hypem
       Playlist.new(@type,@arg,@page-1).get
     end
 
+    def self.create_url(tracks)
+      raise ArgumentError if (!tracks.is_a? Array) || (!tracks.first.is_a? Hypem::Track)
+      track_params = tracks.map(&:id).join(',')
+      playlist = Playlist.new('set',track_params)
+      return Hypem::ROOT_PATH + playlist.path
+    end
+
     def self.latest
       Playlist.new(:time,:today).get
     end

data/lib/hypem/request.rb

@@ -1,6 +1,7 @@
 require 'faraday'
 
 module Hypem
+  ROOT_PATH = 'http://hypem.com'
   class Request
     attr_accessor :response
     attr_reader :url
@@ -18,7 +19,7 @@ module Hypem
     private
     
     def connection
-      @@conn ||= Faraday.new(url: 'http://hypem.com') do |builder|
+      @@conn ||= Faraday.new(url: ROOT_PATH) do |builder|
         builder.request :url_encoded
         #builder.response :logger
         builder.adapter :net_http

data/lib/hypem/version.rb

@@ -1,3 +1,3 @@
 module Hypem
-  VERSION = "0.0.3"
+  VERSION = "0.1.0"
 end

data/spec/playlist_spec.rb

@@ -12,12 +12,12 @@ describe Hypem::Playlist do
   
   context "when initialized" do
     
-    it "assigns the url attribute" do
-      playlist.url.should == "/playlist/time/today/json/1"
+    it "assigns the path attribute" do
+      playlist.path.should == "/playlist/time/today/json/1"
     end
 
-    it "assigns proper url for blog" do
-      blog_playlist.url.should == "/playlist/blog/1/json/1"
+    it "assigns proper path for blog" do
+      blog_playlist.path.should == "/playlist/blog/1/json/1"
     end
 
   end
@@ -35,6 +35,19 @@ describe Hypem::Playlist do
     end
   end
 
+  describe ".create" do
+    let(:tracks) {[mock('Hypem::Track',id: 'track1',), mock('Hypem::Track',id:'track2')]}
+
+    it "requires an array of tracks" do
+      expect { Hypem::Playlist.create_url(['not_a_track'])}.to raise_error ArgumentError
+    end
+
+    it "returns the correct playlist url " do
+      tracks.first.stub(:is_a?).and_return(true)
+      Hypem::Playlist.create_url(tracks).should == 'http://hypem.com/playlist/set/track1,track2/json/1'
+    end
+  end
+
   describe ".latest" do
     it "returns a playlist" do
       playlist.should be_a Hypem::Playlist

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hypem
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-25 00:00:00.000000000 Z
+date: 2012-03-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70314354528100 !ruby/object:Gem::Requirement
+  requirement: &70128807063420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: '2.6'
   type: :development
   prerelease: false
-  version_requirements: *70314354528100
+  version_requirements: *70128807063420
 - !ruby/object:Gem::Dependency
   name: vcr
-  requirement: &70314354527640 !ruby/object:Gem::Requirement
+  requirement: &70128807062960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: '2.0'
   type: :development
   prerelease: false
-  version_requirements: *70314354527640
+  version_requirements: *70128807062960
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70314354527260 !ruby/object:Gem::Requirement
+  requirement: &70128807062580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70314354527260
+  version_requirements: *70128807062580
 - !ruby/object:Gem::Dependency
   name: faraday
-  requirement: &70314354526720 !ruby/object:Gem::Requirement
+  requirement: &70128807062040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: '0.7'
   type: :runtime
   prerelease: false
-  version_requirements: *70314354526720
+  version_requirements: *70128807062040
 - !ruby/object:Gem::Dependency
   name: multi_json
-  requirement: &70314354526220 !ruby/object:Gem::Requirement
+  requirement: &70128807061540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +65,10 @@ dependencies:
         version: '1.1'
   type: :runtime
   prerelease: false
-  version_requirements: *70314354526220
+  version_requirements: *70128807061540
 - !ruby/object:Gem::Dependency
   name: hashie
-  requirement: &70314354525760 !ruby/object:Gem::Requirement
+  requirement: &70128807061080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -76,7 +76,7 @@ dependencies:
         version: '1.2'
   type: :runtime
   prerelease: false
-  version_requirements: *70314354525760
+  version_requirements: *70128807061080
 description: 
 email:
 - jackcanderson@gmail.com
@@ -140,7 +140,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2921270312575464942
+      hash: 2841197461574656335
 requirements: []
 rubyforge_project: hypem
 rubygems_version: 1.8.10