hypem 0.0.1

data/fixtures/vcr_cassettes/user_profile.yml

@@ -0,0 +1,44 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://hypem.com/api/get_profile?username=jackca
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers: {}
+  response:
+    status:
+      code: 200
+      message: 
+    headers:
+      server:
+      - nginx/1.0.12
+      date:
+      - Sat, 24 Mar 2012 22:07:39 GMT
+      content-type:
+      - text/javascript; charset=UTF-8
+      transfer-encoding:
+      - chunked
+      connection:
+      - close
+      set-cookie:
+      - AUTH=03%3A1536f8f35d43a41d289bf5cbf9e227d7%3A1332626858%3A1276002699%3ACA-US;
+        expires=Mon, 20-Mar-2028 22:07:38 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":"JackCA","profile_url":"http:\/\/hypem.com\/JackCA","fullname":"Jack
+        Anderson","twitter_username":"janderson","userpic":"http:\/\/faces-s3.hypem.com\/123376863051420_75.png","joined_ts":1238371615,"favorites_count":{"user":4,"item":430,"site":32,"query":15,"followers":1},"location":"San
+        Francisco, CA, US"}'
+    http_version: 
+  recorded_at: Sat, 24 Mar 2012 22:07:39 GMT
+recorded_with: VCR 2.0.0

data/hypem.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "hypem/version"
+
+Gem::Specification.new do |s|
+  s.name        = "hypem"
+  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.rubyforge_project = "hypem"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency "rspec", "~> 2.6"
+  s.add_development_dependency "vcr", "~> 2.0"
+  s.add_development_dependency "rake"
+  s.add_dependency 'faraday', '~> 0.7'
+  s.add_dependency 'multi_json', '~> 1.1'
+  s.add_dependency 'hashie', '~> 1.2'
+
+end

data/lib/hypem.rb

@@ -0,0 +1,21 @@
+require "hypem/response"
+require "hypem/request"
+require "hypem/user"
+require "hypem/track"
+require "hypem/playlist"
+
+module Hypem
+
+  #convenient way of accessing module classes
+  def self.method_missing(method, *args)
+    method_name = method.capitalize
+    raise ArgumentError unless self.const_defined? method_name
+    if args.empty?
+      self.const_get(method_name)
+    else
+      self.const_get(method_name).send(:new, *args)
+    end
+  end
+
+end
+

data/lib/hypem/playlist.rb

@@ -0,0 +1,56 @@
+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_reader :extended
+
+    def initialize(type,arg,page=1)
+      @type = type
+      @arg = arg
+      @page = page
+      @url = "/playlist/#{@type}/#{@arg}/json/#{@page}"
+    end
+
+    def get
+      response = Request.new(url).get.response
+      @tracks = []
+      # getting rid of version cell
+      response.body.shift
+      response.body.each_value{|v| @tracks << Track.new(v)}
+      return self
+    end
+
+    def next_page
+      Playlist.new(@type,@arg,@page+1).get
+    end
+
+    def prev_page
+      Playlist.new(@type,@arg,@page-1).get
+    end
+
+    def self.latest
+      Playlist.new(:time,:today).get
+    end
+
+    def self.popular(arg=POPULAR_ARGS.first)
+      arg = arg.to_sym if arg.is_a? String
+      raise ArgumentError unless POPULAR_ARGS.include?(arg)
+      Playlist.new(:popular,arg).get
+    end
+
+    def self.friends_history(user)
+      Playlist.new(:people_history,user).get
+    end
+
+    def self.friends_favorites(user)
+      Playlist.new(:people,user).get
+    end
+
+    # meta method definitions for generic playlists
+    GENERIC_METHODS.each do |method|
+      define_singleton_method(method) {|arg| Playlist.new(method,arg).get }
+    end
+
+  end
+end

data/lib/hypem/request.rb

@@ -0,0 +1,28 @@
+require 'faraday'
+
+module Hypem
+  class Request
+    attr_accessor :response
+    attr_reader :url
+
+    def initialize(url)
+      @url = url
+    end
+
+    def get
+      raw_response = connection.get(@url)
+      @response = Response.new(raw_response)
+      return self
+    end
+
+    private
+    
+    def connection
+      @@conn ||= Faraday.new(url: 'http://hypem.com') do |builder|
+        builder.request :url_encoded
+        #builder.response :logger
+        builder.adapter :net_http
+      end
+    end
+  end
+end

data/lib/hypem/response.rb

@@ -0,0 +1,14 @@
+require 'multi_json'
+
+module Hypem
+  class Response
+    attr_accessor :body
+
+    def initialize(raw_response)
+      raise ArgumentError if raw_response.nil?
+      # raise on body error here
+      @body = MultiJson.decode raw_response.body
+    end
+
+  end
+end

data/lib/hypem/track.rb

@@ -0,0 +1,35 @@
+require 'hashie'
+
+module Hypem
+
+  class Track < Hashie::Trash
+    property :media_id, from: :mediaid
+    property :artist
+    property :title
+    property :date_posted, from: :dateposted
+    property :site_id, from: :siteid
+    property :sitename
+    property :post_url, from: :posturl
+    property :post_url_first, from: :posturl_first
+    property :post_id, from: :postid
+    property :date_posted_first, from: :dateposted_first
+    property :site_id_first, from: :siteid_first
+    property :site_name_first, from: :sitename_first
+    property :post_id_first, from: :postid_first
+    property :loved_count
+    property :posted_count
+    property :thumb_url
+    property :thumb_url_large
+    property :time
+    property :description
+    property :itunes_link
+    property :date_played, from: :dateplayed
+    property :date_loved, from: :dateloved
+    property :user_name, from: :username
+    property :full_name, from: :fullname
+    property :via_query
+    property :plays #used by obsessed playlist
+
+  end
+
+end

data/lib/hypem/user.rb

@@ -0,0 +1,49 @@
+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
+
+    def initialize(name)
+      raise ArgumentError unless name.is_a? String
+      @name = name
+    end
+
+    def get_profile
+      response = Request.new("/api/get_profile?username=#{@name}").get.response.body
+      @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
+    end
+
+    #playlist requests
+
+    def loved_playlist
+      Playlist.loved(@name)
+    end
+
+    def obsessed_playlist
+      Playlist.obsessed(@name)
+    end
+
+    def feed_playlist
+      Playlist.feed(@name)
+    end
+
+    def friends_favorites_playlist
+      Playlist.friends_favorites(@name)
+    end
+
+    def friends_history_playlist
+      Playlist.friends_history(@name)
+    end
+
+  end
+end

data/lib/hypem/version.rb

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

data/spec/hypem_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe Hypem do
+  describe "convenience methods" do
+    it "can access playlist class" do
+ #     pending
+    end
+
+    it "can access user class" do
+      Hypem.user('jackca').should be_a Hypem::User
+    end
+  end
+end

data/spec/playlist_spec.rb

@@ -0,0 +1,132 @@
+require 'spec_helper'
+
+describe Hypem::Playlist do
+  let(:playlist) do
+    VCR.use_cassette('latest_playlist'){Hypem::Playlist.latest}
+  end
+  
+  let(:blog_playlist) do
+    VCR.use_cassette('blog_playlist'){Hypem::Playlist.blog(1)}
+  end
+  
+  
+  context "when initialized" do
+    
+    it "assigns the url attribute" do
+      playlist.url.should == "/playlist/time/today/json/1"
+    end
+
+    it "assigns proper url for blog" do
+      blog_playlist.url.should == "/playlist/blog/1/json/1"
+    end
+
+  end
+
+  describe "after get" do
+
+    it "should be a playlist" do
+      playlist.should be_a Hypem::Playlist
+    end
+
+    describe "tracks" do
+      it "should assign tracks attribute" do
+        playlist.tracks.should_not be_nil
+      end
+    end
+  end
+
+  describe ".latest" do
+    it "returns a playlist" do
+      playlist.should be_a Hypem::Playlist
+    end
+  end
+
+  describe ".popular" do
+    before {Hypem::Playlist.stub_chain(:new, :get)}
+
+    it "converts strings to symbols" do
+      Hypem::Playlist.should_receive(:new).with(:popular,%s(3day))
+      Hypem::Playlist.popular('3day')
+    end
+
+    it "retrieves 3day by default" do
+      Hypem::Playlist.should_receive(:new).with(:popular,%s(3day))
+      Hypem::Playlist.popular
+    end
+
+    it "accepts lastweek" do
+      Hypem::Playlist.should_receive(:new).with(:popular,:lastweek)
+      Hypem::Playlist.popular(:lastweek)
+    end
+
+    it "accepts noremix" do
+      Hypem::Playlist.should_receive(:new).with(:popular,:noremix)
+      Hypem::Playlist.popular(:noremix)
+    end
+
+    it "accepts artists" do
+      Hypem::Playlist.should_receive(:new).with(:popular,:artists)
+      Hypem::Playlist.popular(:artists)
+    end
+
+    it "accepts twitter" do
+      Hypem::Playlist.should_receive(:new).with(:popular,:twitter)
+      Hypem::Playlist.popular(:twitter)
+    end
+
+    it "rejects anything else" do
+      expect {Hypem::Playlist.popular(:no_no)}.to raise_error(ArgumentError)
+    end
+  end
+
+  context "class methods" do
+    before {Hypem::Playlist.stub_chain(:new, :get)}
+    
+    describe ".blog" do  
+      it "calls new with type blog" do
+        Hypem::Playlist.should_receive(:new).with(:blog,1)
+        Hypem::Playlist.blog(1)
+      end
+    end
+  
+    describe ".tags" do
+      it "calls new with type tags" do
+        Hypem::Playlist.should_receive(:new).with(:tags,'tag')
+        Hypem::Playlist.tags('tag')
+      end
+    end
+  
+    describe ".search" do
+      it "calls new with type search" do
+        Hypem::Playlist.should_receive(:new).with(:search,'query')
+        Hypem::Playlist.search('query')
+      end
+    end
+  
+    describe ".artist" do
+      it "calls new with type artist" do
+        Hypem::Playlist.should_receive(:new).with(:artist,'name')
+        Hypem::Playlist.artist('name')
+      end
+    end
+  end
+  
+  describe "pagination" do
+    before do
+      playlist
+      Hypem::Playlist.stub_chain(:new,:get)
+    end
+
+    it "can get next page" do
+      Hypem::Playlist.should_receive(:new).with(:time,:today,2)
+      playlist.next_page
+    end
+
+    it "also gets previous page" do
+      Hypem::Playlist.should_receive(:new).with(:time,:today,0)
+      playlist.prev_page
+    end
+
+  end
+
+end

data/spec/request_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+describe Hypem::Request do
+
+  let(:request) do
+    Hypem::Request.new('/playlist/latest/fresh/json/1')
+  end
+
+  let(:response) do
+    VCR.use_cassette('fresh_playlist') do
+      request.get.response
+    end
+  end
+
+  context "at initialization" do
+
+    it "must have a url string parameter" do
+      expect { Hypem::Request.new }.to raise_error ArgumentError
+    end
+
+    it "assigns the response attribute" do
+      response.should be_a Hypem::Response
+    end
+
+  end
+
+  it "makes get requests" do
+    response.body.should_not be_nil
+    response.body.should_not be_empty
+  end
+
+
+end