hypem 0.2.1 → 0.3.0

data/README.md

@@ -1,4 +1,4 @@
-# Hypem Ruby Gem ![travis](https://secure.travis-ci.org/JackCA/hypem.png?branch=master) #
+# Hypem Ruby Gem [![travis](https://secure.travis-ci.org/JackCA/hypem.png?branch=master)](http://travis-ci.org/JackCA/hypem) [![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/JackCA/hypem)#
 ## Introduction ##
 This is an unoffical Ruby gem for the **Hype Machine** read-only API. It currently only supports Ruby `1.9.x`.
 
@@ -94,6 +94,15 @@ An example track object inspection is as follows:
 
 ****** 
 
+### Track Favorites ###
+The people who liked a track can be retrieved via `Hypem::TrackFavorites('trackid')` or `track.favorites` and synced using the `get` method.
+
+Their pagination is supplied via the same methods as the `Hypem::Playlist` ones, and they also accept the desired page as the last argument at initialization : `Hypem::TrackFavorites('trackid', page)`
+
+The `Hypem::Users` present in each page can be retrieved via the `users` instance method
+
+****** 
+
 ## TODO ###
 - Blogs with given tag
 - Authenticated Requests

data/hypem.gemspec

@@ -22,8 +22,8 @@ Gem::Specification.new do |s|
   s.add_development_dependency "vcr", "~> 2.0"
   s.add_development_dependency "webmock"
   s.add_development_dependency "rake"
+  s.add_development_dependency "timecop"
   s.add_dependency 'httparty'
   s.add_dependency 'andand'
-  s.add_dependency 'multi_json', '~> 1.1'
 
 end

data/lib/hypem.rb

@@ -1,12 +1,15 @@
 require "andand"
 require "hypem/helper"
-require "hypem/response"
 require "hypem/request"
 require "hypem/user"
 require "hypem/track"
 require "hypem/playlist"
 require "hypem/blog"
-require "exceptions"
+require "hypem/exceptions"
+
+require "hypem/track_favorites_request"
+require "hypem/track_favorites"
+
 
 module Hypem
 

data/lib/hypem/helper.rb

@@ -7,9 +7,7 @@ module Hypem
 
     def update_from_response(raw_hash)
       raw_hash.each_pair do |key,value|
-        key = key.to_sym
-        new_key = self.class.key_conversions[key]
-        key = new_key unless new_key.nil?
+        key = self.class.key_conversions[key.to_sym] || key.to_sym
 
         if self.class.datetime_conversions.andand.include? key
           value = Time.at(value).to_datetime 

data/lib/hypem/track.rb

@@ -37,6 +37,9 @@ module Hypem
       self
     end
 
+    def favorites(page=nil)
+      @track_favorites ||= TrackFavorites.new(@media_id)
+    end
 
   end
 end

data/lib/hypem/track_favorites.rb

@@ -0,0 +1,49 @@
+module Hypem
+  class TrackFavorites
+    include Helper
+    
+    attr_accessor :users, :media_id
+    
+    LIMIT = 20
+    
+    def initialize(media_id, page=nil)
+      page = 1 if page.nil?
+      @media_id = media_id
+      @page = page
+    end
+    
+    def get
+      user_ids = TrackFavoritesRequest.get_data(path)
+      @users = user_ids.map{|user_id| User.new(user_id)}
+      self
+    end
+    
+    def next_page
+      TrackFavorites.new(@media_id,@page+1).get
+    end
+
+    def prev_page
+      TrackFavorites.new(@media_id,@page+1).get
+    end
+
+    def page(num)
+      TrackFavorites.new(@media_id,num).get
+    end
+
+    private
+    
+    def path
+      timestamp = Time.now.to_i
+      items_to_skip = (@page - 1)*LIMIT
+
+      return "/serve_activity_info.php?" + [
+        "type=favorites",
+        "id=#{media_id}",
+        "skip=#{items_to_skip}",
+        "limit=#{LIMIT}",
+        "ts=#{timestamp}"
+      ].join("&")
+    end
+    
+  end
+end

data/lib/hypem/track_favorites_request.rb

@@ -0,0 +1,14 @@
+module Hypem
+  class TrackFavoritesRequest < Request
+    
+    base_uri 'http://hypem.com/inc'
+    format :html
+    
+    # Extract the response in a user names enumerator
+    def self.get_data(path)
+      response = get(path)
+      return response.body.scan(/<span>(\w*)<\/span>/).flatten
+    end
+    
+  end
+end

data/lib/hypem/user.rb

@@ -14,19 +14,15 @@ module Hypem
       @name = name
     end
 
-    def get(resource)
-      Request.get_resource("#{resource}?username=#{@name}")
-    end
-
     def get_profile
-      response = get('/get_profile')
+      response = get_resource('/get_profile')
       flattened_response = flatten_response(response)
-      update_from_response(response)
+      update_from_response(flattened_response)
       self
     end
 
     def favorite_blogs
-      response = get('/get_favorite_blogs')
+      response = get_resource('/get_favorite_blogs')
 
       response.map do |r|
         blog = Hypem::Blog.new(r['siteid'])
@@ -36,7 +32,7 @@ module Hypem
     end
 
     def friends
-      response = get('/get_friends')
+      response = get_resource('/get_friends')
 
       response.map do |r|
         user = User.new(r['username'])
@@ -45,7 +41,6 @@ module Hypem
       end
     end
 
-
     #playlist requests
 
     def loved_playlist(page=1)
@@ -78,5 +73,9 @@ module Hypem
       end
       response
     end
+
+    def get_resource(resource)
+      Request.get_resource("#{resource}?username=#{@name}")
+    end
   end
 end

data/lib/hypem/version.rb

@@ -1,3 +1,3 @@
 module Hypem
-  VERSION = "0.2.1"
+  VERSION = "0.3.0"
 end

data/spec/fixtures/vcr_cassettes/track_favorites.yml

@@ -0,0 +1,80 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://hypem.com/inc/serve_activity_info.php?id=1jsw9&limit=20&skip=0&ts=1350518333&type=favorites
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - text/html
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx/1.2.3
+      Date:
+      - Wed, 17 Oct 2012 23:58:53 GMT
+      Content-Type:
+      - text/html; charset=UTF-8
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      Keep-Alive:
+      - timeout=10
+    body:
+      encoding: US-ASCII
+      string: ! '<div class="favcountlist"><div class="close-this"></div><h4>Loved
+        By</h4><ul><li ><a  href="/Celia_BL"><img src=''http://faces-s3.hypem.com/1240942225538552_75.png''
+        class="avatar-s" width="30" height="30" title=''Celia_BL loved this 4 days
+        ago''/> <span>Celia_BL</span></a><li ><a  href="/stephronson"><img src=''http://faces-s3.hypem.com/2208821703498672_75.png''
+        class="avatar-s" width="30" height="30" title=''stephronson loved this 5 days
+        ago''/> <span>stephronson</span></a><li ><a  href="/patchouli89"><img src=''http://faces-s3.hypem.com/915584976021997_75.png''
+        class="avatar-s" width="30" height="30" title=''patchouli89 loved this last
+        week''/> <span>patchouli89</span></a><li ><a  href="/DubTasticSemen"><img
+        src=''http://faces-s3.hypem.com/4899791450234933_75.png'' class="avatar-s"
+        width="30" height="30" title=''DubTasticSemen loved this last week''/> <span>DubTasticSemen</span></a><li
+        ><a  href="/katiep"><img src=''http://faces-s3.hypem.com/183261887691666_75.png''
+        class="avatar-s" width="30" height="30" title=''katiep loved this on Oct 1st''/>
+        <span>katiep</span></a><li ><a  href="/Darktrain"><img src=''http://faces-s3.hypem.com/129147371270505_75.png''
+        class="avatar-s" width="30" height="30" title=''Darktrain loved this on Oct
+        1st''/> <span>Darktrain</span></a><li ><a  href="/aubreycamille"><img src=''http://faces-s3.hypem.com/443902290006435_75.png''
+        class="avatar-s" width="30" height="30" title=''aubreycamille loved this on
+        Sep 30th''/> <span>aubreycamille</span></a><li ><a  href="/Makailax"><img
+        src=''http://faces-s3.hypem.com/6829031078555215_75.png'' class="avatar-s"
+        width="30" height="30" title=''Makailax loved this on Sep 26th''/> <span>Makailax</span></a><li
+        ><a  href="/picapwel"><img src=''http://faces-s3.hypem.com/861286451970126_75.png''
+        class="avatar-s" width="30" height="30" title=''picapwel loved this on Sep
+        26th''/> <span>picapwel</span></a><li ><a  href="/SpaghettiArms"><img src=''http://faces-s3.hypem.com/802561691180543_75.png''
+        class="avatar-s" width="30" height="30" title=''SpaghettiArms loved this on
+        Sep 24th''/> <span>SpaghettiArms</span></a><li ><a  href="/vachco"><img src=''http://faces-s3.hypem.com/11657621703909853_75.png''
+        class="avatar-s" width="30" height="30" title=''vachco loved this on Sep 21st''/>
+        <span>vachco</span></a><li ><a  href="/jrodney"><img src=''http://faces-s3.hypem.com/3629451415173087_75.png''
+        class="avatar-s" width="30" height="30" title=''jrodney loved this on Sep
+        21st''/> <span>jrodney</span></a><li ><a  href="/ciscogoya"><img src=''http://faces-s3.hypem.com/69212976015486_75.png''
+        class="avatar-s" width="30" height="30" title=''ciscogoya loved this on Sep
+        21st''/> <span>ciscogoya</span></a><li ><a  href="/jillian8"><img src=''http://faces-s3.hypem.com/6808391081805987_75.png''
+        class="avatar-s" width="30" height="30" title=''jillian8 loved this on Sep
+        20th''/> <span>jillian8</span></a><li ><a  href="/jennagordon"><img src=''http://faces-s3.hypem.com/12569241449517956_75.png''
+        class="avatar-s" width="30" height="30" title=''jennagordon loved this on
+        Sep 20th''/> <span>jennagordon</span></a><li ><a  href="/fnezrob"><img src=''http://faces-s3.hypem.com/1010779881277052_75.png''
+        class="avatar-s" width="30" height="30" title=''fnezrob loved this on Sep
+        17th''/> <span>fnezrob</span></a><li ><a  href="/Terijan"><img src=''http://faces-s3.hypem.com/7834091852750270_75.png''
+        class="avatar-s" width="30" height="30" title=''Terijan loved this on Sep
+        17th''/> <span>Terijan</span></a><li ><a  href="/randoo"><img src=''http://faces-s3.hypem.com/9562582079546783_75.png''
+        class="avatar-s" width="30" height="30" title=''randoo loved this on Sep 17th''/>
+        <span>randoo</span></a><li ><a  href="/hhoneymoon"><img src=''http://faces-s3.hypem.com/1279187495880144_75.png''
+        class="avatar-s" width="30" height="30" title=''hhoneymoon loved this on Sep
+        17th''/> <span>hhoneymoon</span></a><li ><a  href="/Tunch"><img src=''http://faces-s3.hypem.com/3887221963549886_75.png''
+        class="avatar-s" width="30" height="30" title=''Tunch loved this on Sep 17th''/>
+        <span>Tunch</span></a></ul><a href="" onclick="update_item_activity(''favorites'',
+        ''1jsw9'', ''20'', ''20''); return false;" class="fav-paging">Next 20 &raquo;</a><script
+        type="text/javascript">jQuery(".avatar-s img[title]").tooltip({ position:
+        "top center", offset: [-2,0]});</script></div>'
+    http_version: 
+  recorded_at: Wed, 17 Oct 2012 23:58:53 GMT
+recorded_with: VCR 2.2.5

data/spec/track_favorites_request_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+
+describe Hypem::TrackFavoritesRequest do
+
+  describe "#get_data" do
+    # Tested in Hypem::TrackFavorites#get
+  end
+
+end

data/spec/track_favorites_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+require 'timecop'
+
+describe Hypem::TrackFavorites do
+  
+  let(:media_id) { '1jsw9' }
+  let(:track_favorites_from_string) { described_class.new(media_id) }
+
+  describe "#get" do
+    subject do
+
+      # Fetching the last request date, so the timestamp in the request match,
+      # and VCR doesn't try to fetch a new episode
+      @last_request_time = VCR::Cassette.new("track_favorites").serializable_hash.values.first.last["recorded_at"]
+      
+      Timecop.freeze(@last_request_time) do
+        VCR.use_cassette("track_favorites") do
+          track_favorites_from_string.get
+        end
+      end
+    end
+    
+    its(:users) { should be_a Array }    
+  end
+  
+  
+  
+end

data/spec/track_spec.rb

@@ -6,7 +6,7 @@ describe Hypem::Track do
       Hypem::Request.get('/playlist/latest/all/json/1')["0"]
     end
   end
-
+  
   let(:media_id) { '1jsw9' }
   let(:track_from_hash) { described_class.new(track_hash) }
   let(:track_from_string) { described_class.new(media_id) }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hypem
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-27 00:00:00.000000000 Z
+date: 2012-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70284220238720 !ruby/object:Gem::Requirement
+  requirement: &70109952730500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: '2.6'
   type: :development
   prerelease: false
-  version_requirements: *70284220238720
+  version_requirements: *70109952730500
 - !ruby/object:Gem::Dependency
   name: vcr
-  requirement: &70284220238260 !ruby/object:Gem::Requirement
+  requirement: &70109952730040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: '2.0'
   type: :development
   prerelease: false
-  version_requirements: *70284220238260
+  version_requirements: *70109952730040
 - !ruby/object:Gem::Dependency
   name: webmock
-  requirement: &70284220237880 !ruby/object:Gem::Requirement
+  requirement: &70109952729660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70284220237880
+  version_requirements: *70109952729660
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70284220237420 !ruby/object:Gem::Requirement
+  requirement: &70109952729200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,21 +54,21 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70284220237420
+  version_requirements: *70109952729200
 - !ruby/object:Gem::Dependency
-  name: httparty
-  requirement: &70284220237000 !ruby/object:Gem::Requirement
+  name: timecop
+  requirement: &70109952728760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
-  version_requirements: *70284220237000
+  version_requirements: *70109952728760
 - !ruby/object:Gem::Dependency
-  name: andand
-  requirement: &70284220236580 !ruby/object:Gem::Requirement
+  name: httparty
+  requirement: &70109952728340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,18 +76,18 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70284220236580
+  version_requirements: *70109952728340
 - !ruby/object:Gem::Dependency
-  name: multi_json
-  requirement: &70284220236080 !ruby/object:Gem::Requirement
+  name: andand
+  requirement: &70109952727920 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70284220236080
+  version_requirements: *70109952727920
 description: 
 email:
 - jackcanderson@gmail.com
@@ -102,14 +102,15 @@ files:
 - README.md
 - Rakefile
 - hypem.gemspec
-- lib/exceptions.rb
 - lib/hypem.rb
 - lib/hypem/blog.rb
+- lib/hypem/exceptions.rb
 - lib/hypem/helper.rb
 - lib/hypem/playlist.rb
 - lib/hypem/request.rb
-- lib/hypem/response.rb
 - lib/hypem/track.rb
+- lib/hypem/track_favorites.rb
+- lib/hypem/track_favorites_request.rb
 - lib/hypem/user.rb
 - lib/hypem/version.rb
 - spec/blog_spec.rb
@@ -117,6 +118,7 @@ files:
 - spec/fixtures/vcr_cassettes/blog_all.yml
 - spec/fixtures/vcr_cassettes/latest_playlist.yml
 - spec/fixtures/vcr_cassettes/single_track.yml
+- spec/fixtures/vcr_cassettes/track_favorites.yml
 - spec/fixtures/vcr_cassettes/user_favorite_blogs.yml
 - spec/fixtures/vcr_cassettes/user_friends.yml
 - spec/fixtures/vcr_cassettes/user_profile.yml
@@ -124,6 +126,8 @@ files:
 - spec/playlist_spec.rb
 - spec/request_spec.rb
 - spec/spec_helper.rb
+- spec/track_favorites_request_spec.rb
+- spec/track_favorites_spec.rb
 - spec/track_spec.rb
 - spec/user_spec.rb
 homepage: https://github.com/JackCA/hypem
@@ -146,7 +150,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2570760148147230779
+      hash: -3140532029222442359
 requirements: []
 rubyforge_project: hypem
 rubygems_version: 1.8.10
@@ -159,6 +163,7 @@ test_files:
 - spec/fixtures/vcr_cassettes/blog_all.yml
 - spec/fixtures/vcr_cassettes/latest_playlist.yml
 - spec/fixtures/vcr_cassettes/single_track.yml
+- spec/fixtures/vcr_cassettes/track_favorites.yml
 - spec/fixtures/vcr_cassettes/user_favorite_blogs.yml
 - spec/fixtures/vcr_cassettes/user_friends.yml
 - spec/fixtures/vcr_cassettes/user_profile.yml
@@ -166,5 +171,7 @@ test_files:
 - spec/playlist_spec.rb
 - spec/request_spec.rb
 - spec/spec_helper.rb
+- spec/track_favorites_request_spec.rb
+- spec/track_favorites_spec.rb
 - spec/track_spec.rb
 - spec/user_spec.rb

data/lib/hypem/response.rb

@@ -1,14 +0,0 @@
-require 'multi_json'
-
-module Hypem
-  class Response
-    attr_accessor :body
-
-    def initialize(raw_response)
-      raise RequestError if raw_response.body == 'null'
-
-      @body = MultiJson.decode raw_response.body
-    end
-
-  end
-end