mixcloud 0.0.3

data/lib/mixcloud.rb

@@ -0,0 +1,16 @@
+require 'rubygems'
+require 'rest_client'
+require 'json'
+require 'rspec'
+
+require 'mixcloud/popular_new_hot'
+require 'mixcloud/url_helper'
+require 'mixcloud/resource'
+require 'mixcloud/artist'
+require 'mixcloud/category'
+require 'mixcloud/cloudcast'
+require 'mixcloud/section'
+require 'mixcloud/tag'
+require 'mixcloud/track'
+require 'mixcloud/user'
+require 'mixcloud/search'

data/lib/mixcloud/artist.rb

@@ -0,0 +1,14 @@
+module Mixcloud
+  class Artist < Resource
+    include Mixcloud::PopularNewHot
+    attr_accessor :name, 
+                  :key,
+                  :slug,
+                  :public_url,
+                  :api_url
+    # This class contains the following instance methods
+    # #popular_url
+    # #new_url
+    # #hot_url
+  end
+end

data/lib/mixcloud/category.rb

@@ -0,0 +1,27 @@
+module Mixcloud
+  class Category < Mixcloud::Resource
+    attr_accessor :name, 
+                  :format,
+                  :public_url,
+                  :api_url,
+                  :key,
+                  :slug
+
+    # This class contains the following instance methods:
+    # #small_picture_url
+    # #large_picture_url
+    # #medium_picture_url
+    # #thumbnail_picture_url
+    # #medium_mobile_picture_url
+    # #userpick_users_url 
+    # #userpick_cloudcasts_url
+    # #users_url
+    # #cloudcasts_url
+
+    ['userpick_users', 'userpick_cloudcasts', 'users', 'cloudcasts' ].each do | connection |
+      define_method "#{connection}_url" do
+        UrlHelper.turn_www_to_api(@public_url).concat "#{connection.gsub("_", "-")}/"
+      end
+    end
+  end
+end

data/lib/mixcloud/cloudcast.rb

@@ -0,0 +1,62 @@
+module Mixcloud
+  class Cloudcast < Mixcloud::Resource
+    attr_accessor :listener_count,
+                  :name,
+                  :public_url,
+                  :api_url,
+                  :description,
+                  :updated_time,
+                  :play_count,
+                  :comment_count,
+                  :percentage_music,
+                  :key,
+                  :created_time,
+                  :audio_length,
+                  :slug,
+                  :favorite_count,
+                  :user_url
+
+   # This class contains the following instance methods
+   # #medium_picture_url
+   # #extra_large_picture_url
+   # #large_picture_url
+   # #small_url
+   # #medium_mobile_picture_url
+   # #thumbnail_picture_url
+   # #listeners_url
+   # #similar_url
+   # #favorites_url
+   # #comments_url
+
+   ['listeners', 'similar', 'favorites', 'comments'].each do | connection |
+      define_method "#{connection}_url" do
+        UrlHelper.turn_www_to_api(@public_url) + "#{connection.gsub("_", "-")}/?metadata=1"
+      end
+    end
+
+    def sections
+      convert_hash_data_into_array_of('sections')
+    end
+
+    def tag_urls
+      convert_hash_data_into_array_of('tags')
+    end
+
+    #######################################################################
+    private
+    def convert_hash_data_into_array_of(type)
+      raise 'I only take sections of tags, dude' unless ['sections', 'tags'].include?(type)
+      elements_hash = JSON.parse(RestClient.get @api_url)[type]
+      objects_array = []
+      elements_hash.each do | element |
+        if type == 'sections'
+          objects_array << Mixcloud::Section.new(UrlHelper.turn_www_to_api(element['track']['url']), element['position'], element['start_type'], element['section_type'] )
+        elsif type == 'tags'
+          objects_array << UrlHelper.turn_www_to_api(element['url']).concat('?metadata=1')
+        end
+      end
+      objects_array
+    end
+
+  end
+end

data/lib/mixcloud/popular_new_hot.rb

@@ -0,0 +1,15 @@
+module Mixcloud
+  module PopularNewHot
+    def popular_url
+      UrlHelper.turn_www_to_api(@public_url).concat 'popular/'
+    end
+
+    def new_url
+      UrlHelper.turn_www_to_api(@public_url).concat 'new/'
+    end
+
+    def hot_url
+      UrlHelper.turn_www_to_api(@public_url).concat 'hot/'
+    end
+  end
+end

data/lib/mixcloud/resource.rb

@@ -0,0 +1,51 @@
+module Mixcloud
+  class Resource
+
+    def initialize(url)
+      UrlHelper.validate_mixcloud_url(url)
+      url_with_metadata = UrlHelper.concat_with_metadata(url)
+      data_hash = JSON.parse RestClient.get(url_with_metadata)
+      klass =  Mixcloud.const_get(data_hash['type'].capitalize)
+      prevent_url_and_class_mismatch(klass)
+      map_to_resource_attributes(data_hash)
+    end
+
+
+    ###########################################
+    private
+
+    def prevent_url_and_class_mismatch(klass)
+      if klass != self.class
+        raise "You tried to create an object of #{self.class} with an URL of object type #{klass}"
+      end
+    end
+
+    def map_to_resource_attributes(data_hash)
+      data_hash.each_pair do | key, value |
+        next if ['metadata', 'sections', 'tags', 'type'].include?(key)
+        create_picture_url_methods(value) and next if key == 'pictures'
+        set_public_and_api_urls(value) and next if key == 'url'
+        key,value = set_associated_object_urls(key, value) if Mixcloud.const_defined?(key.capitalize)
+        send("#{key}=", value) 
+      end
+    end
+
+    def create_picture_url_methods(picture_hash)
+      picture_hash.each_pair do |format, picture_url|
+        self.class.send(:define_method, "#{format}_picture_url") { picture_url }
+      end
+    end
+
+    def set_public_and_api_urls(url_string)
+      send("public_url=", url_string)
+      send("api_url=", UrlHelper.turn_www_to_api(url_string)).concat('?metadata=1')
+    end
+
+    def set_associated_object_urls(key, value)
+      variable_name = key + "_url"
+      object_url = UrlHelper.turn_www_to_api(value['url']).concat('?metadata=1')
+      [ variable_name, object_url ]
+    end
+    ############################################
+  end
+end

data/lib/mixcloud/search.rb

@@ -0,0 +1,36 @@
+module Mixcloud
+  class Search
+
+    # The codeblock below defines the following class methods:
+    # Mixcloud::Search.find_artist 
+    # Mixcloud::Search.find_cloudcast
+    # Mixcloud::Search.find_user
+    # Mixcloud::Search.find_tag
+    SEARCH_TYPES = ['artist', 'cloudcast', 'user', 'tag']
+    SEARCH_TYPES.each do |type|
+      define_singleton_method "find_#{type}" do | name |
+        search_url = create_search_url(name, type)
+        data_returned = JSON.parse(RestClient.get search_url)['data']
+        search_results = turn_data_into_mixcloud_resources(data_returned, Mixcloud.const_get(type.capitalize))
+        search_results
+      end
+    end
+
+    private
+    def self.create_search_url(name, type)
+      name.gsub! " ", "+"
+      "http://api.mixcloud.com/search/?q=#{name}&type=#{type}"
+    end
+
+    def self.turn_data_into_mixcloud_resources(results, klass)
+      search_results = []
+      results.each do |result|
+        resource_api_url = UrlHelper.turn_www_to_api result['url']
+        resource = klass.new(resource_api_url)
+        search_results << resource
+      end
+      search_results
+    end
+
+  end
+end

data/lib/mixcloud/section.rb

@@ -0,0 +1,12 @@
+module Mixcloud
+  class Section
+    attr_accessor :track_url, :position, :start_time, :section_type
+    
+    def initialize(track_url, position, start_time, section_type)
+      @track_url = track_url
+      @position = position
+      @start_time = start_time
+      @section_type = section_type
+    end
+  end
+end

data/lib/mixcloud/tag.rb

@@ -0,0 +1,13 @@
+module Mixcloud
+  class Tag < Mixcloud::Resource
+    include Mixcloud::PopularNewHot
+    attr_accessor :public_url, 
+                  :api_url,
+                  :name,
+                  :key
+    # This class contains the following instance methods
+    # #popular_url
+    # #new_url
+    # #hot_url
+  end
+end

data/lib/mixcloud/track.rb

@@ -0,0 +1,15 @@
+module Mixcloud
+  class Track < Mixcloud::Resource
+    include PopularNewHot
+    attr_accessor :public_url,
+                  :api_url,
+                  :name,
+                  :key,
+                  :slug,
+                  :artist_url
+    # This class contains the following instance methods
+    # #popular_url
+    # #new_url
+    # #hot_url
+  end
+end

data/lib/mixcloud/url_helper.rb

@@ -0,0 +1,38 @@
+module Mixcloud
+  class UrlHelper
+
+    class << self
+      ##################################
+      public
+      def validate_mixcloud_url(url)
+        raise "You provided an invalid Mixcloud-API url. It must start with http://api.mixcloud.com/" unless url =~ /\Ahttp:\/\/api.mixcloud.com\//
+      end
+
+      def concat_with_metadata(url)
+        return url if ends_with_metadata?(url)
+        return url.chop if ends_with_metadata_slash?(url)
+        url.concat('/') unless ends_with_slash?(url)
+        url.concat('?metadata=1')
+      end
+
+      def turn_www_to_api(url)
+        url.strip.sub('http://www.', 'http://api.' ) if url.strip =~ /\Ahttp:\/\/www./
+      end
+      ##################################
+      private 
+      def ends_with_metadata?(url)
+        true if url =~ /\?metadata=1$/
+      end
+
+      def ends_with_metadata_slash?(url)
+        true if url =~ /\?metadata=1\/$/
+      end
+
+      def ends_with_slash?(url)
+        url =~ /\/\z/
+      end
+      ##################################
+    end
+
+  end
+end

data/lib/mixcloud/user.rb

@@ -0,0 +1,42 @@
+module Mixcloud
+  class User < Mixcloud::Resource
+    attr_accessor :username, 
+                  :name,
+                  :cloudcast_count,
+                  :following_count,
+                  :public_url,
+                  :api_url,
+                  :listen_count,
+                  :key,
+                  :follower_count,
+                  :favorite_count,
+                  :updated_time,
+                  :created_time,
+                  :pictures,
+                  :city,
+                  :biog,
+                  :country
+
+    # This class contains the following instance methods
+    # #medium_picture_url
+    # #extra_large_picture_url
+    # #large_picture_url
+    # #small_url
+    # #medium_mobile_picture_url
+    # #thumbnail_picture_url
+    # #feed_url
+    # #playlists_url
+    # #comments_url
+    # #followers_url
+    # #favorites_url
+    # #following_url
+    # #cloudcasts_url
+    # #listens_url
+    ['feed', 'playlists', 'comments', 'followers', 'favorites', 'following', 'cloudcasts', 'listens'].each do |connection|
+      define_method "#{connection}_url" do
+        "http://api.mixcloud.com#{@key}#{connection}/"
+      end
+    end
+
+  end
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: mixcloud
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+  prerelease: 
+platform: ruby
+authors:
+- Alex Fong
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-01-17 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: &2161429600 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.7
+  type: :runtime
+  prerelease: false
+  version_requirements: *2161429600
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: &2161429080 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.1
+  type: :runtime
+  prerelease: false
+  version_requirements: *2161429080
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2161428580 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *2161428580
+description: Ruby wrapper of the Mixcloud API. Visit http://www.mixcloud.com/developers/documentation/
+  for more info
+email: actfong@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/mixcloud.rb
+- lib/mixcloud/artist.rb
+- lib/mixcloud/category.rb
+- lib/mixcloud/cloudcast.rb
+- lib/mixcloud/popular_new_hot.rb
+- lib/mixcloud/resource.rb
+- lib/mixcloud/search.rb
+- lib/mixcloud/section.rb
+- lib/mixcloud/tag.rb
+- lib/mixcloud/track.rb
+- lib/mixcloud/url_helper.rb
+- lib/mixcloud/user.rb
+homepage: http://www.github.com/actfong/mixcloud
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: Ruby wrapper of the Mixcloud API. It allows you to builld Mixcloud resources
+  as Ruby objects and provides search functionality
+test_files: []
+has_rdoc: