jammed 0.1.0

data/lib/jammed/user.rb

@@ -0,0 +1,158 @@
+module Jammed #:nodoc:
+  # Provides User objects for interacting with user-specific data
+  class User
+    
+    # Each attr_accessor (except for :username) caches API data on first use in corresponding instance variable
+    attr_accessor :username, :followers, :following, :jams, :likes, :profile
+
+    # Creates a new Jammed::User object and assigns a username to @username
+    #
+    # ==== Attributes
+    #
+    # * +username+ - Username of user to make API calls with
+    #
+    # ==== Examples
+    #
+    #       iftfom = Jammed::User.new('IFTFOM', '08972935872035')
+    def initialize(username, api_key)
+      @username = username
+      @api_key = api_key
+    end
+
+    def followers(opts={})
+      @followers ||= Jammed::Followers.followers(@username, @api_key, opts)
+    end
+
+    # Clears cached Followers data with a fresh call to Jammed::Followers
+    #
+    # ==== Attributes
+    #
+    # * +opts+ - Options for ordering Followers data
+    #
+    # ==== Options
+    #
+    # * +:order+ - A symbol determining how the data is orderd like :date, :affinity, or :alpha
+    #
+    # ==== Examples
+    #
+    #     user = Jammed::User.new('IFTFOM', '08972935872035')
+    #     user.followers #returns all followers of IFTFOM
+    #     user.followers(:order => :date) #reutrns IFTFOM's followers ordered by date
+    def followers!(opts={})
+      @followers = Jammed::Followers.followers(@username, @api_key, opts)
+    end
+
+    def following(opts={})
+      @following ||= Jammed::Following.following(@username, @api_key, opts)
+    end
+
+    # Clears cached Following data with a fresh call to Jammed::Following
+    #
+    # ==== Attributes
+    #
+    # * +opts+ - Options for ordering Following data
+    #
+    # ==== Options
+    #
+    # * +:order+ - A symbol determining how the data is orderd like :date, :affinity, or :alpha
+    #
+    # ==== Examples
+    #
+    #     user = Jammed::User.new('IFTFOM', '08972935872035')
+    #     user.following #returns all followings of IFTFOM
+    #     user.following(:order => :date) #returns IFTFOM's followings ordered by date
+    def following!(opts={})
+      @following = Jammed::Following.following(@username, @api_key, opts)
+    end
+
+    def jams(opts={})
+      @jams ||= Jammed::Jams.jams(@username, @api_key, opts)
+    end
+
+    # Clears cached Jams data with a fresh call to Jammed::Jams
+    #
+    # ==== Attributes
+    #
+    # * +opts+ - Options for which data is shown
+    #
+    # ==== Options
+    #
+    # * +:show+ - A symbol determining what data is shown like :past or :current
+    #
+    # ==== Examples
+    #
+    #     user = Jammed::User.new('IFTFOM', '08972935872035')
+    #     user.jams #returns all jams of IFTFOM
+    #     user.jams(:show => :past) #returns IFTFOM's past jams
+    def jams!(opts={})
+      @jams = Jammed::Jams.jams(@username, @api_key, opts)
+    end
+
+    def likes(opts={})
+      @likes ||= Jammed::Likes.likes(@username, @api_key, opts)
+    end
+
+    # Clears cached Likes data with a fresh call to Jammed::Likes
+    #
+    # ==== Attributes
+    #
+    # * +opts+ - Options for which data is shown
+    #
+    # ==== Options
+    #
+    # * +:show+ - A symbol determining what data is shown like :past or :current
+    #
+    # ==== Examples
+    #
+    #     user = Jammed::User.new('IFTFOM', '08972935872035')
+    #     user.likes #returns all likes of IFTFOM
+    #     user.likes(:show => :past) #returns IFTFOM's past likes
+    def likes!(opts={})
+      @likes = Jammed::Likes.likes(@username, @api_key, opts)
+    end
+    
+    def profile
+      @profile ||= Jammed::Person.profile(@username, @api_key)
+    end
+
+    # Clears cached Person data with a fresh call to Jammed::Person
+    #
+    # ==== Examples
+    #
+    #     user = Jammed::User.new('IFTFOM', '08972935872035')
+    #     user.profile #returns entire profile of IFTFOM
+    def profile!
+      @profile = Jammed::Person.profile(@username, @api_key)
+    end
+
+    # Checks user's profile for attribute and returns value if attribute key is found.
+    #
+    # ==== Examples
+    #
+    #     user = Jammed::User.new('IFTFOM', '08972935872035')
+    #     user.name #returns 'IFTFOM'
+    #     user.date_joined #uses js_namify to find 'dateJoined' key and returns date
+    def method_missing(name, *args, &block)
+      n = name.to_s.index('_') != nil ? js_namify(name.to_s) : name.to_s
+
+      profile.has_key?(n) ? profile[n] : super
+    end
+
+    # Converts Ruby styled method names to JavaScript's prefered style. Used by method_missing to generate dynamic attributes methods for user's profile.
+    #
+    # ==== Attributes
+    #
+    # * +name+ - Method name to be converted
+    #
+    # ==== Examples
+    #
+    #     js_namify('date_joined') #returns 'dateJoined'
+    def js_namify(name)
+      x = []
+      name.split('_').each_with_index do |e, i|
+        i == 0 ? x << e.downcase : x << e.capitalize
+      end
+      x.join('')
+    end
+  end
+end

data/lib/jammed/version.rb

@@ -0,0 +1,4 @@
+module Jammed
+  #:nodoc:
+  VERSION = "0.1.0"
+end

data/lib/jammed.rb

@@ -0,0 +1,28 @@
+require 'httparty'
+Dir[File.dirname(__FILE__) + '/jammed/*.rb'].each do |file|
+  require file
+end
+
+module Jammed
+
+  class Search #:nodoc:
+    include HTTParty
+    base_uri 'http://api.thisismyjam.com/1'
+  end
+  
+  class << self
+    #Creates a Jammed::Base object for interacting with the API
+    #
+    # ==== Attributes
+    #
+    # * +api_key+ - Sets the API key to use for all calls made with object
+    # * +opts+ -Options hash. Does nothing at the moment.
+    #
+    # ==== Examples
+    #
+    #     jammed = Jammed.new('987bcab01b929eb2c07877b224215c92')
+    def new(api_key='987bcab01b929eb2c07877b224215c92', opts={})
+      Jammed::Base.new(api_key, opts)
+    end
+  end
+end

data/spec/jammed/base_spec.rb

@@ -0,0 +1,90 @@
+require 'spec_helper'
+
+module Jammed
+  describe Base do 
+
+    let(:api_key) {'987bcab01b929eb2c07877b224215c92'}
+    let(:jammed) {Jammed::Base.new(api_key)}
+    let(:user) {'IFTFOM'}
+
+    describe "#initialize" do
+    end
+
+    describe "#followers" do 
+      it "calls Jammed::Followers.followers" do
+        Jammed::Followers.should_receive(:followers)
+        jammed.followers(user)
+      end
+    end
+
+    describe "#following" do 
+      it "calls Jammed::Following.following" do
+        Jammed::Following.should_receive(:following)
+        jammed.following(user)
+      end
+    end
+
+    describe "#jams" do 
+      it "calls Jammed::Jams.jams" do
+        Jammed::Jams.should_receive(:jams)
+        jammed.jams(user)
+      end
+    end
+
+    describe "#likes" do 
+      it "calls Jammed::Like.likes" do
+        Jammed::Likes.should_receive(:likes)
+        jammed.likes(user)
+      end
+    end
+
+    describe "#popular_jams" do 
+      it "calls Jammed::PopularJams.popular_jams" do
+        Jammed::PopularJams.should_receive(:popular_jams)
+        jammed.popular_jams
+      end
+    end
+
+    describe "#profile" do 
+      it "calls Jammed::Person.profile" do
+        Jammed::Person.should_receive(:profile)
+        jammed.profile(user)
+      end
+    end
+
+    describe "#search_name" do 
+      it "calls Jammed::PeopleSearch.search_name" do
+        Jammed::PeopleSearch.should_receive(:search_name)
+        jammed.search_name(user)
+      end
+    end
+
+    describe "#search_artist" do 
+      it "calls Jammed::PeopleSearch.search_artist" do
+        Jammed::PeopleSearch.should_receive(:search_artist)
+        jammed.search_artist('track')
+      end
+    end
+
+    describe "#search_track" do 
+      it "calls Jammed::PeopleSearch.search_track" do
+        Jammed::PeopleSearch.should_receive(:search_track)
+        jammed.search_track('artist', 'track')
+      end
+    end
+
+    describe "#suggested_people" do 
+      it "calls Jammed::SuggestedPeople.people" do
+        Jammed::SuggestedPeople.should_receive(:people)
+        jammed.suggested_people
+      end
+    end
+
+    describe "#user" do 
+      it "calls Jammed::User.new" do
+        Jammed::User.should_receive(:new).with(user, api_key)
+        jammed.user(user)
+      end
+    end
+  end
+end

data/spec/jammed/followers_spec.rb

@@ -0,0 +1,55 @@
+require 'spec_helper'
+
+module Jammed
+  describe Followers do 
+
+    let(:api_key) {'987bcab01b929eb2c07877b224215c92'}
+
+    describe ".followers" do    
+      before do
+        serve_response("http://api.thisismyjam.com/1/IFTFOM/followers.json?key=987bcab01b929eb2c07877b224215c92", :followers)
+      end
+      
+      it "gets followers from the api" do
+        Jammed::Followers.followers('IFTFOM', api_key).should_not be_nil
+      end
+    end
+
+    describe ".followers(:order => :date)" do
+      before do
+        serve_response("http://api.thisismyjam.com/1/IFTFOM/followers.json?key=987bcab01b929eb2c07877b224215c92&order=followedDate", :followers_date)
+      end
+      
+      it "can order followers by date" do
+        Jammed::Followers.followers('IFTFOM', api_key, :order => :date).should_not be_nil
+      end
+    end
+
+    describe ".followers(:order => :affinity)" do
+      before do
+        serve_response("http://api.thisismyjam.com/1/IFTFOM/followers.json?key=987bcab01b929eb2c07877b224215c92&order=affinity", :followers_affinity)
+      end
+      
+      it "can order followers by likes" do
+        Jammed::Followers.followers('IFTFOM', api_key, :order => :affinity).should_not be_nil
+      end
+    end
+
+    describe ".followers(:order => :name)" do
+      before do
+        serve_response("http://api.thisismyjam.com/1/IFTFOM/followers.json?key=987bcab01b929eb2c07877b224215c92&order=name", :followers_name)
+      end
+      
+      it "can order followers by name" do
+        Jammed::Followers.followers('IFTFOM', api_key, :order => :name).should_not be_nil
+      end
+    end
+
+    context ".followers with bad :order value" do
+      it "complains when non-existant :order value given" do
+        message = "Cannot order Followers by bad"
+        Jammed::Followers.followers('IFTFOM', api_key, :order => :bad).should == message
+      end
+    end
+  end
+end

data/spec/jammed/following_spec.rb

@@ -0,0 +1,55 @@
+require 'spec_helper'
+
+module Jammed
+  describe Following do
+
+    let(:api_key) {'987bcab01b929eb2c07877b224215c92'}
+
+    describe ".following" do
+      before do
+        serve_response("http://api.thisismyjam.com/1/IFTFOM/following.json?key=987bcab01b929eb2c07877b224215c92", :following)
+      end
+      
+      it "gets followings from the api" do
+        Jammed::Following.following('IFTFOM', api_key).should_not be(nil)
+      end
+    end
+
+    describe ".following(:order => :date)" do
+      before do
+        serve_response("http://api.thisismyjam.com/1/IFTFOM/following.json?key=987bcab01b929eb2c07877b224215c92&order=followedDate", :following_date)
+      end
+      
+      it "can order followings by date" do
+        Jammed::Following.following('IFTFOM', api_key, :order => :date).should_not be_nil
+      end
+    end
+
+    describe ".following(:order => :affinity)" do 
+      before do
+        serve_response("http://api.thisismyjam.com/1/IFTFOM/following.json?key=987bcab01b929eb2c07877b224215c92&order=affinity", :following_affinity)
+      end
+      
+      it "can order followings by likes" do
+        Jammed::Following.following('IFTFOM', api_key, :order => :affinity).should_not be_nil
+      end
+    end
+
+    describe ".following(:order => :name)" do
+      before do
+        serve_response("http://api.thisismyjam.com/1/IFTFOM/following.json?key=987bcab01b929eb2c07877b224215c92&order=name", :following_name)
+      end
+      
+      it "can order followings by name" do
+        Jammed::Following.following('IFTFOM', api_key, :order => :name).should_not be_nil
+      end
+    end 
+
+    context ".following with bad :order value" do
+      it "complains when non-existant :order value given" do
+        message = "Cannot order Followings by bad"
+        Jammed::Following.following('IFTFOM', api_key, :order => :bad).should == message
+      end
+    end
+  end
+end

data/spec/jammed/jams_spec.rb

@@ -0,0 +1,53 @@
+require 'spec_helper'
+
+module Jammed
+  describe Jams do
+    
+    let(:api_key) {'987bcab01b929eb2c07877b224215c92'}
+
+    describe ".jams" do
+      before do
+        serve_response("http://api.thisismyjam.com/1/IFTFOM/jams.json?key=987bcab01b929eb2c07877b224215c92", :jams)
+      end
+      
+      it "gets jams from the api" do
+        Jammed::Jams.jams('IFTFOM', api_key).should_not be(nil)
+      end
+
+      it "gets the current jam and past jams" do
+        Jammed::Jams.jams('IFTFOM', api_key).to_s.should include("\"current\"=>false")
+        Jammed::Jams.jams('IFTFOM', api_key).to_s.should include("\"current\"=>true")
+      end
+    end
+
+    describe ".jams(:show => :past)" do
+      before do
+        serve_response("http://api.thisismyjam.com/1/IFTFOM/jams.json?key=987bcab01b929eb2c07877b224215c92&show=past", :jams_past)
+      end
+      
+      it "gets past jams from the api" do
+        Jammed::Jams.jams('IFTFOM', api_key, :show => :past).should_not be(nil)
+        Jammed::Jams.jams('IFTFOM', api_key, :show => :past).to_s.should include("\"current\"=>false")
+      end
+
+      it "doesn't get the current jam" do
+        Jammed::Jams.jams('IFTFOM', api_key, :show => :past).to_s.should_not include("\"current\"=>true")
+      end
+    end
+
+    describe ".jams(:show => :current)" do
+      before do
+        serve_response("http://api.thisismyjam.com/1/IFTFOM/jams.json?key=987bcab01b929eb2c07877b224215c92", :jams)
+      end
+      
+      it "gets the current jam from the api" do
+        Jammed::Jams.jams('IFTFOM', api_key, :show => :current).should_not be(nil)
+        Jammed::Jams.jams('IFTFOM', api_key, :show => :current).to_s.should include("\"current\"=>true")
+      end
+
+      it "doesn't get past jams" do
+        Jammed::Jams.jams('IFTFOM', api_key, :show => :current).to_s.should_not include("\"current\"=>false")
+      end
+    end
+  end
+end

data/spec/jammed/likes_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+
+module Jammed
+  describe Likes do
+
+    let(:api_key) {'987bcab01b929eb2c07877b224215c92'}
+
+    describe ".likes" do
+      before do
+        serve_response("http://api.thisismyjam.com/1/IFTFOM/likes.json?key=987bcab01b929eb2c07877b224215c92", :likes)
+      end
+      
+      it "gets likes from the api" do
+        Jammed::Likes.likes('IFTFOM', api_key).should_not be(nil)
+      end
+
+      it "gets both current and past likes" do
+        Jammed::Likes.likes('IFTFOM', api_key).to_s.should include("\"current\"=>false")
+        Jammed::Likes.likes('IFTFOM', api_key).to_s.should include("\"current\"=>true")
+      end
+    end
+
+    describe ".likes(:show => :current)" do
+      before do
+        serve_response("http://api.thisismyjam.com/1/IFTFOM/likes.json?show=current&key=987bcab01b929eb2c07877b224215c92", :likes_current)
+      end
+      
+      it "gets current likes" do
+        Jammed::Likes.likes('IFTFOM', api_key, :show => :current).to_s.should include("\"current\"=>true")
+      end
+
+      it "doesn't get past likes" do
+        Jammed::Likes.likes('IFTFOM', api_key, :show => :current).to_s.should_not include("\"current\"=>false")
+      end
+    end
+
+    describe ".likes(:show => :past)" do
+      before do
+        serve_response("http://api.thisismyjam.com/1/IFTFOM/likes.json?show=past&key=987bcab01b929eb2c07877b224215c92", :likes_past)
+      end
+      
+      it "gets past likes" do
+        Jammed::Likes.likes('IFTFOM', api_key, :show => :past).to_s.should include("\"current\"=>false")
+      end
+
+      it "doesn't get current likes" do
+        Jammed::Likes.likes('IFTFOM', api_key, :show => :past).to_s.should_not include("\"current\"=>true")
+      end
+    end
+  end
+end

data/spec/jammed/people_search_spec.rb

@@ -0,0 +1,79 @@
+require 'spec_helper'
+
+module Jammed
+  describe PeopleSearch do
+
+    let(:api_key) {'987bcab01b929eb2c07877b224215c92'}
+
+    describe ".search_name" do
+      let(:query) {'institute'}
+      let(:search) { Jammed::PeopleSearch.search_name(query, api_key) }
+      before do 
+        serve_response("http://api.thisismyjam.com/1/search/person.json?by=name&q=institute&key=987bcab01b929eb2c07877b224215c92", :search_name)
+      end
+
+      it "returns people from the API" do
+        search.should_not be(nil)
+      end
+
+      it "returns people with the search string in their username, fullname, or Twitter name" do
+        successful_search = false
+        if search.first["fullname"].downcase.include?(query)
+          successful_search = true
+        elsif search.first["name"].downcase.include?(query)
+          successful_search = true
+        elsif search.first["twitterName"].downcase.include?(query)
+          successful_search = true
+        end
+        successful_search.should be true
+      end
+    end
+
+    describe ".search_artist" do
+      let(:query) {'beach boys'}
+      let(:search) { Jammed::PeopleSearch.search_artist(query, api_key) }
+
+      before do 
+        serve_response("http://api.thisismyjam.com/1/search/person.json?by=artist&q=beach+boys&key=987bcab01b929eb2c07877b224215c92", :search_artist)
+      end
+
+      it "returns people from the API" do
+        search.should_not be(nil)
+      end
+
+      it "returns people who have posted tracks by the queried artist" do
+        successful_search = false
+        search.first["representativeArtists"].each do |artist|
+          if artist.downcase.include?(query)
+            successful_search = true
+          end
+          successful_search.should be true
+        end
+      end
+    end
+
+    describe ".search_track" do
+      let(:query_artist) {'Lana del Rey'}
+      let(:query_track) {'Video games'}
+      let(:search) { Jammed::PeopleSearch.search_track(query_artist, query_track, api_key)}
+
+      before do 
+        serve_response("http://api.thisismyjam.com/1/search/person.json?by=track&q=Lana+del+Rey|Video+games&key=987bcab01b929eb2c07877b224215c92", :search_track)
+      end
+
+      it "returns people from the API" do
+        search.should_not be(nil)
+      end
+
+      it "returns people who have posted a particluar track" do
+        successful_search = false
+        search.first["representativeArtists"].each do |artist|
+          if artist.downcase.include?(query_artist.downcase)
+            successful_search = true
+          end
+          successful_search.should be true
+        end
+      end
+    end
+  end
+end

data/spec/jammed/person_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+module Jammed
+  describe Person do 
+
+    let(:api_key) {'987bcab01b929eb2c07877b224215c92'}
+
+    before do
+      serve_response("http://api.thisismyjam.com/1/IFTFOM.json?key=987bcab01b929eb2c07877b224215c92", :person)
+    end
+
+    describe ".profile" do
+      
+      it "gets the data from the api" do
+        Jammed::Person.profile('IFTFOM', api_key)["name"].should == "IFTFOM"
+      end
+
+      it "parses the JSON return into a hash" do
+        Jammed::Person.profile('IFTFOM', api_key).should be_an_instance_of Hash
+      end
+    end
+
+    describe "dynamic attributes (.method_missing)" do
+      
+      it "returns the attribute value if present in profile (name)" do
+        Jammed::Person.name('IFTFOM', api_key).should == "IFTFOM"
+      end
+
+      it "returns the attribute value if present in profile" do
+        Jammed::Person.fullname('IFTFOM', api_key).should match /Institute/
+      end
+
+      it "raises method missing if attribute is not present" do
+        lambda { Jammed::Person.foo_attribute('IFTFOM', api_key) }.should raise_error NoMethodError
+      end
+    end
+  end
+end

data/spec/jammed/popular_jams_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+module Jammed
+  describe PopularJams do 
+
+    let(:api_key) {'987bcab01b929eb2c07877b224215c92'}
+
+    describe ".popular_jams" do
+      
+      before do
+        serve_response("http://api.thisismyjam.com/1/popular.json?key=987bcab01b929eb2c07877b224215c92", :popular)
+      end
+      
+      it "parses the JSON return into an array of Jams" do
+        Jammed::PopularJams.popular_jams(api_key).should be_an_instance_of Array
+      end
+
+      it "gets popular jams from the api" do
+        Jammed::PopularJams.popular_jams(api_key).should_not be_nil
+      end
+    end
+  end
+end

data/spec/jammed/suggested_people_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+module Jammed
+  describe SuggestedPeople do
+
+    let(:api_key) {'987bcab01b929eb2c07877b224215c92'}
+
+    describe ".people" do
+      before do
+        serve_response("http://api.thisismyjam.com/1/suggestedPeople.json?key=987bcab01b929eb2c07877b224215c92", :suggested_people)
+      end
+      
+      it "returns people from the API" do
+        Jammed::SuggestedPeople.people(api_key).should_not be_nil
+      end
+    end
+  end
+end