hypem 0.0.1 → 0.0.2

data/README.md

@@ -1,6 +1,6 @@
 # Hypem Ruby Gem ![travis](https://secure.travis-ci.org/JackCA/hypem.png?branch=master) #
 ## Introduction ##
-This is an unoffical Ruby gem for the **Hype Machine** public API. It supports all of the supported Playlist requests and wraps all responses in custom Ruby objects. It currently only supports Ruby `1.9.x`.
+This is an unoffical Ruby gem for the **Hype Machine** read-only API. It supports all of the Playlist request methods and a growing number of User methods. It currently only supports Ruby `1.9.x`.
 
 ## Usage ##
 
@@ -54,22 +54,29 @@ Each playlist has a `tracks` attribute containing an array of `Hypem::Tracks`'s.
 ******
 
 ### User ###
-`Hypem::User` offers several convenience methods for accessing a particular user's personalized playlists:
+Users can be accessed via `Hypem.user('username')` and have various methods:
+#### General Methods ####
+- `user.get_profile` updates the user object with the following attributes: `full_name`, `location`, `image_url`, `followed_users_count`, `followed_items_count`, `followed_sites_blog`, and `followed_queries_count`
 
-- `Hypem.user('name').loved_playlist` --- a user's loved tracks
+- `user.get_friends` retrieves the users's friends and sets the `friends` attribute to an array of `Hypem::User` objects with extended information (similar to `get_profile`)
 
-- `Hypem.user('name').obsessed_playlist` --- a user's obsessed tracks
+#### Playlist Methods ####
+`Hypem::User` offers several methods for accessing a particular user's personalized playlists:
 
-- `Hypem.user('name').feed_playlist` --- a user's tracks from all followed entities
+- `user.loved_playlist` --- a user's loved tracks
 
-- `Hypem.user('name').friends_favorites_playlist` --- a user's friends' favorited tracks
+- `user.obsessed_playlist` --- a user's obsessed tracks
 
-- `Hypem.user('name').friends_history_playlist` --- tracks from a user's friends' listening histories
+- `user.feed_playlist` --- a user's tracks from all followed entities
+
+- `user.friends_favorites_playlist` --- a user's friends' favorited tracks
+
+- `user.friends_history_playlist` --- tracks from a user's friends' listening histories
 
 ******
 
 ### Track ###
-All of the above methods return an Playlist object with an attribute `tracks` 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/fixtures/vcr_cassettes/user_friends.yml

@@ -0,0 +1,44 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://hypem.com/api/get_friends?username=jackca
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers: {}
+  response:
+    status:
+      code: 200
+      message: 
+    headers:
+      server:
+      - nginx/1.0.12
+      date:
+      - Sun, 25 Mar 2012 03:00:06 GMT
+      content-type:
+      - text/html
+      transfer-encoding:
+      - chunked
+      connection:
+      - close
+      set-cookie:
+      - AUTH=03%3A944cc1ba58791e209abd7bb5ab98a727%3A1332644405%3A1276002699%3ACA-US;
+        expires=Tue, 21-Mar-2028 03:00:05 GMT; path=/; domain=hypem.com
+      x-hacker:
+      - Hey, if you're reading this, you should drop us an email at hypem.com/contact,
+        maybe we can work together!
+      access-control-allow-origin:
+      - ! '*'
+      access-control-allow-headers:
+      - ! '*'
+      vary:
+      - Accept-Encoding
+    body:
+      encoding: ASCII-8BIT
+      string: ! '[{"username":"anthony","dateadded":1331660275,"fullname":"Anthony","profile_url":"http:\/\/hypem.com\/anthony","userpic":"http:\/\/faces-s3.hypem.com\/20727986008_75.png","favorites_count":{"user":127,"item":355,"site":30,"query":13,"followers":1874},"radio_avail":false},{"username":"janestar","dateadded":"1292962523","fullname":null,"profile_url":"http:\/\/hypem.com\/janestar","userpic":"http:\/\/static-ak.hypem.net\/images\/bg-album-art.gif","favorites_count":{"user":0,"item":4,"site":0,"query":0,"followers":3},"radio_avail":false},{"username":"jstreet","dateadded":"0","fullname":"Justin
+        Street","profile_url":"http:\/\/hypem.com\/jstreet","userpic":"http:\/\/faces-s3.hypem.com\/39640740001973_75.png","favorites_count":{"user":7,"item":367,"site":24,"query":0,"followers":4},"radio_avail":false},{"username":"danielzarick","dateadded":"0","fullname":"Daniel
+        Zarick","profile_url":"http:\/\/hypem.com\/danielzarick","userpic":"http:\/\/faces-s3.hypem.com\/782356165259973_75.png","favorites_count":{"user":25,"item":9,"site":0,"query":4,"followers":12},"radio_avail":false}]'
+    http_version: 
+  recorded_at: Sun, 25 Mar 2012 03:00:06 GMT
+recorded_with: VCR 2.0.0

data/hypem.gemspec

@@ -7,8 +7,8 @@ Gem::Specification.new do |s|
   s.version     = Hypem::VERSION
   s.authors     = ["Jack Anderson"]
   s.email       = ["jackcanderson@gmail.com"]
-  s.homepage    = ""
-  s.summary     = "a light Ruby wrapper for the Hype Machine public API"
+  s.homepage    = "https://github.com/JackCA/hypem"
+  s.summary     = "a Ruby wrapper for the Hype Machine read-only API"
 
   s.rubyforge_project = "hypem"
 

data/lib/hypem/user.rb

@@ -2,7 +2,7 @@ module Hypem
   class User
     attr_reader :full_name, :joined_at, :location, :twitter_username, :image_url,
                 :followed_users_count, :followed_items_count, :followed_sites_count,
-                :followed_queries_count
+                :followed_queries_count, :friends
 
     def initialize(name)
       raise ArgumentError unless name.is_a? String
@@ -11,16 +11,33 @@ module Hypem
 
     def get_profile
       response = Request.new("/api/get_profile?username=#{@name}").get.response.body
+      update_from_response(response)
+      return self
+    end
+
+    def get_friends
+      array_response = Request.new("/api/get_friends?username=#{@name}").get.response.body
+      @friends = array_response.map do |r|
+        name = r['username']
+        user = User.new(name)
+        user.update_from_response(r)
+        user
+      end
+      return self
+    end
+
+    def update_from_response(response)
       @full_name = response['fullname']
-      @joined_at = Time.at response['joined_ts']
       @location = response['location']
-      @twitter_username = response['twitter_username']
       @image_url = response['userpic']
       @followed_users_count = response['favorites_count']['user']
       @followed_items_count = response['favorites_count']['item']
       @followed_sites_count = response['favorites_count']['site']
       @followed_queries_count = response['favorites_count']['query']
-      return self
+
+      # only returned on get_profile
+      @joined_at = Time.at(response['joined_ts']) unless response['joined_ts'].nil?
+      @twitter_username = response['twitter_username']
     end
 
     #playlist requests

data/lib/hypem/version.rb

@@ -1,3 +1,3 @@
 module Hypem
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/user_spec.rb

@@ -43,7 +43,7 @@ describe Hypem::User do
 
   describe ".get_profile" do
     let(:user_with_profile) do
-      VCR.use_cassette('user_profile') {Hypem::User.new('jackca').get_profile}
+      VCR.use_cassette('user_profile') {user.get_profile}
     end
 
     subject {user_with_profile}
@@ -59,4 +59,18 @@ describe Hypem::User do
     its(:followed_queries_count) {should == 15}
   end
 
+  describe ".get_friends" do
+    let(:user_with_friends) do
+      VCR.use_cassette('user_friends') {user.get_friends}
+    end
+
+    subject {user_with_friends}
+
+    its(:friends) {should be_an Array}
+
+    it "has an array of users" do
+      user_with_friends.friends.first.should be_a Hypem::User
+    end
+  end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hypem
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-03-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70253643657760 !ruby/object:Gem::Requirement
+  requirement: &70304769757740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: '2.6'
   type: :development
   prerelease: false
-  version_requirements: *70253643657760
+  version_requirements: *70304769757740
 - !ruby/object:Gem::Dependency
   name: vcr
-  requirement: &70253643657260 !ruby/object:Gem::Requirement
+  requirement: &70304769757240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: '2.0'
   type: :development
   prerelease: false
-  version_requirements: *70253643657260
+  version_requirements: *70304769757240
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70253643656880 !ruby/object:Gem::Requirement
+  requirement: &70304769756860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70253643656880
+  version_requirements: *70304769756860
 - !ruby/object:Gem::Dependency
   name: faraday
-  requirement: &70253643656340 !ruby/object:Gem::Requirement
+  requirement: &70304769756320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: '0.7'
   type: :runtime
   prerelease: false
-  version_requirements: *70253643656340
+  version_requirements: *70304769756320
 - !ruby/object:Gem::Dependency
   name: multi_json
-  requirement: &70253643655840 !ruby/object:Gem::Requirement
+  requirement: &70304769755820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +65,10 @@ dependencies:
         version: '1.1'
   type: :runtime
   prerelease: false
-  version_requirements: *70253643655840
+  version_requirements: *70304769755820
 - !ruby/object:Gem::Dependency
   name: hashie
-  requirement: &70253643655380 !ruby/object:Gem::Requirement
+  requirement: &70304769755360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -76,7 +76,7 @@ dependencies:
         version: '1.2'
   type: :runtime
   prerelease: false
-  version_requirements: *70253643655380
+  version_requirements: *70304769755360
 description: 
 email:
 - jackcanderson@gmail.com
@@ -99,6 +99,7 @@ files:
 - fixtures/vcr_cassettes/loved_playlist.yml
 - fixtures/vcr_cassettes/obsessed_playlist.yml
 - fixtures/vcr_cassettes/popular_playlist.yml
+- fixtures/vcr_cassettes/user_friends.yml
 - fixtures/vcr_cassettes/user_profile.yml
 - hypem.gemspec
 - lib/hypem.rb
@@ -115,7 +116,7 @@ files:
 - spec/spec_helper.rb
 - spec/track_spec.rb
 - spec/user_spec.rb
-homepage: ''
+homepage: https://github.com/JackCA/hypem
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -129,7 +130,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -349130193381970777
+      hash: 2867882639312664006
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -138,13 +139,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -349130193381970777
+      hash: 2867882639312664006
 requirements: []
 rubyforge_project: hypem
 rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
-summary: a light Ruby wrapper for the Hype Machine public API
+summary: a Ruby wrapper for the Hype Machine read-only API
 test_files:
 - spec/hypem_spec.rb
 - spec/playlist_spec.rb