soundcloud-plus 0.0.1

data/.gitignore

@@ -0,0 +1,3 @@
+pkg/*
+*.gem
+.bundle

data/.rvmrc

@@ -0,0 +1,55 @@
+#!/usr/bin/env bash
+
+# This is an RVM Project .rvmrc file, used to automatically load the ruby
+# development environment upon cd'ing into the directory
+
+# First we specify our desired <ruby>[@<gemset>], the @gemset name is optional.
+environment_id="ruby-1.9.2-p290@soundcloud-plus"
+
+#
+# Uncomment following line if you want options to be set only for given project.
+#
+# PROJECT_JRUBY_OPTS=( --1.9 )
+
+#
+# First we attempt to load the desired environment directly from the environment
+# file. This is very fast and efficient compared to running through the entire
+# CLI and selector. If you want feedback on which environment was used then
+# insert the word 'use' after --create as this triggers verbose mode.
+#
+if [[ -d "${rvm_path:-$HOME/.rvm}/environments" \
+  && -s "${rvm_path:-$HOME/.rvm}/environments/$environment_id" ]]
+then
+  \. "${rvm_path:-$HOME/.rvm}/environments/$environment_id"
+
+  if [[ -s "${rvm_path:-$HOME/.rvm}/hooks/after_use" ]]
+  then
+    . "${rvm_path:-$HOME/.rvm}/hooks/after_use"
+  fi
+else
+  # If the environment file has not yet been created, use the RVM CLI to select.
+  if ! rvm --create  "$environment_id"
+  then
+    echo "Failed to create RVM environment '${environment_id}'."
+    exit 1
+  fi
+fi
+
+#
+# If you use an RVM gemset file to install a list of gems (*.gems), you can have
+# it be automatically loaded. Uncomment the following and adjust the filename if
+# necessary.
+#
+# filename=".gems"
+# if [[ -s "$filename" ]]
+# then
+#   rvm gemset import "$filename" | grep -v already | grep -v listed | grep -v complete | sed '/^$/d'
+# fi
+
+# If you use bundler, this might be useful to you:
+# if command -v bundle && [[ -s Gemfile ]]
+# then
+#   bundle install
+# fi
+
+

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in soundcloud-plus.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,50 @@
+PATH
+  remote: .
+  specs:
+    soundcloud-plus (0.0.1)
+      active_support
+      soundcloud (~> 0.2.9)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    active_support (3.0.0)
+      activesupport (= 3.0.0)
+    activesupport (3.0.0)
+    crack (0.1.8)
+    diff-lcs (1.1.3)
+    ffi (1.0.11)
+    guard (0.10.0)
+      ffi (>= 0.5.0)
+      thor (~> 0.14.6)
+    guard-rspec (0.6.0)
+      guard (>= 0.10.0)
+    hashie (1.2.0)
+    httmultiparty (0.3.6)
+      httparty (>= 0.7.3)
+      multipart-post
+    httparty (0.7.8)
+      crack (= 0.1.8)
+    multipart-post (1.1.4)
+    rspec (2.8.0)
+      rspec-core (~> 2.8.0)
+      rspec-expectations (~> 2.8.0)
+      rspec-mocks (~> 2.8.0)
+    rspec-core (2.8.0)
+    rspec-expectations (2.8.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.8.0)
+    soundcloud (0.2.9)
+      hashie
+      httmultiparty (~> 0.3.0)
+      httparty (~> 0.7.3)
+    thor (0.14.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  guard
+  guard-rspec
+  rspec
+  soundcloud-plus!

data/Guardfile

@@ -0,0 +1,22 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec', :version => 2, :cli => "--drb", :all_on_start => false, :all_after_pass => false do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+
+  # Rails example
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^app/(.+)\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^app/(.*)(\.erb|\.haml)$})                 { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
+  watch(%r{^lib/(.+)\.rb$})                           { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch(%r{^app/controllers/(.+)_(controller)\.rb$})  { |m| ["spec/routing/#{m[1]}_routing_spec.rb", "spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb", "spec/acceptance/#{m[1]}_spec.rb"] }
+  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
+  watch('spec/spec_helper.rb')                        { "spec" }
+  watch('config/routes.rb')                           { "spec/routing" }
+  watch('app/controllers/application_controller.rb')  { "spec/controllers" }
+  # Capybara request specs
+  watch(%r{^app/views/(.+)/.*\.(erb|haml)$})          { |m| "spec/requests/#{m[1]}_spec.rb" }
+end
+

data/README.md

@@ -0,0 +1,51 @@
+About
+=====
+
+SoundcloudPlus is a lightweight wrapper for a lightweight wrapper for the Soundcloud web API. 
+
+The official soundcloud gem is pretty bare bones. This builds on top of the the soundclout gem and makes things a little more ruby. It doesn't do much that the soundcloud gem won't do, but it does it in a slightly nicer way.
+
+Instead of 
+
+    client = Soundcloud.new(:client_id => "123456789")
+    client.get("/users/1234/comments", :limit => 5)
+    
+You can do
+
+    client = SoundcloudPlus.new(:client_id => "123456789")
+    client.user(1234).comment.limit(5)
+    or
+    client.user(1234).comments(:limit => 5)
+
+Like all abstractions this one is a little leaky so it helps to know what is going on under the hood. If nothing else, remember that the plurality of the method count.
+
+## Singular methods add resources to the api fetch path
+
+For example:
+
+    client = SoundcloudPlus.new(:client_id => "123456789")
+    client.track(1234).shared_to.email 
+    client.path # => "/tracks/1234/shared-to/emails"
+   
+This path must match the soundcloud web api. You can't do something like
+
+    client.user(1234).comment(4321).track(2345) # Won't work
+   
+## Plural methods add resources to the api path and then fetch
+
+For example
+
+    client = SoundcloudPlus.new(:client_id => "123456789")
+    client.user(1234).favorites # => Array of user 1234's favorites
+    or
+    client.users(1234) # => Hashie with user 1234's information
+
+## Calls to resource properties will also result in a one time fetch
+
+For example
+
+    client = SoundcloudPlus.new(:client_id => "123456789")
+    track  = client.track(1234) # => SoundcloudPlus object with path = "/tracks/1234"
+    track.id  # Makes fetch to "/tracks/1234", returns "1234" 
+              # Subsequent property calls don't result in a fetch.
+

data/Rakefile

@@ -0,0 +1,11 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+task :test => :spec
+task :default => :spec

data/lib/soundcloud-plus.rb

@@ -0,0 +1,127 @@
+
+require 'soundcloud'
+require 'soundcloud-plus/functions'
+require 'uri'
+
+class SoundcloudPlus < Soundcloud
+
+   attr_accessor :path , :options
+
+   PLURAL_CALLS   = %w(user track playlist group comment connection activity app following follower favorite favoriter email)
+   SINGULAR_CALLS = %w(shared-to secret-token all own affiliated exclusive)
+   PARAMETERS =     %w(limit order)
+
+   def initialize(options={})
+      super options
+      @path = ""
+   end
+
+   # Call method on fetched results
+   def method_missing(method, *args, &block)
+      @results ||= self.fetch!
+      @results.send(method)
+   end
+
+   def me
+      @path = "/me"
+   end
+
+   # Tally look up methods
+   SINGULAR_CALLS.each do |call|
+      class_eval <<-METHOD
+         def #{call.gsub('-','_')}(value, options = {})
+            attach("#{call}",value, options)
+         end
+      METHOD
+   end
+
+   PLURAL_CALLS.each do |call|
+      class_eval <<-METHOD
+         def #{call.pluralize}(value = nil, options = {})
+            attach("#{call.pluralize}", value, options).fetch!
+         end
+
+         def #{call}(value = nil, options = {})
+            attach("#{call.pluralize}", value, options)
+         end
+      METHOD
+   end
+
+   PARAMETERS.each do |call|
+      class_eval <<-METHOD
+         def #{call}(value)
+            if value
+               @options[:#{call}] = value 
+               self
+            else
+               @options[:#{call}]
+            end
+         end
+      METHOD
+   end
+
+   # Add parameters to the query options
+   #
+   # @example Adding limit to number of user returned
+   #   client = SoundcloudPlus.new(:client_id => "client_id")
+   #   client.user.where(:limit => 5)
+   #
+   # @return [SoundcloudPlus] self
+   #
+   def where(params = {})
+      @options.merge!(params)
+      self
+   end
+
+   # Attaches resource and resource id path
+   #
+   # @example Attach user resource to path
+   #   client = SoundcloudPlus.new(:client_id => "client_id")
+   #   client.attach("users", "bob")
+   #   client.path  # => /users/1234
+   #
+   # @return [ SoundcloudPlus ] self 
+   #
+   def attach(resource, value = nil, options = {})
+      @path << "/#{resource}"
+      @options.merge!(options)
+      if value
+         @path << (value.class == Fixnum ? "/#{value}" : "/#{resolve(value).id}" )
+      end
+      self
+   end
+
+   # Fetches resources from current path with current options
+   #
+   # @example Fetching user
+   #   client = SoundcloudPlus.new(:client_id => "client_id")
+   #   user = client.user(1234).fetch!
+   #   user.permalink # => "bob"
+   #
+   # @return [Hashie] Hashie containing resource from path
+   #
+   def fetch!
+      old_path = path
+      if old_path && path.length > 0
+         path = ""
+         @results = get(old_path, @options)
+      end
+   end
+   alias :get! :fetch!
+
+   # Finds the soundcloud id for a soundcloud link or path
+   #
+   # @example Getting id of song with link
+   #   client = SoundcloudPlus.new(:client_id => "client_id")
+   #   track = client.resolve("http://soundcloud.com/poopyman/poopy-pants-song") 
+   #   track.name # => "Poopy Pants Song"
+   # 
+   # @example Getting id of song with 
+   #
+   def resolve(path)
+      path = URI.parse(path).path.sub(/\A\/+/,'')
+      url = "http://#{site}/#{path}"
+      @results = get("/resolve", :url => url)
+   end
+
+end

data/lib/soundcloud-plus/functions.rb

@@ -0,0 +1,15 @@
+require 'active_support/inflector'
+
+class String
+
+   # Uses active_support/infectors to determine if a string is singular or plural
+   # 
+   # @example Determining if word is singular
+   #   "poop".singular?  # => true
+   #   "farts".singular? # => false
+   #
+   def singular?
+      self.pluralize != self and self.singularize == self
+   end
+
+end

data/lib/soundcloud-plus/version.rb

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

data/soundcloud-plus.gemspec

@@ -0,0 +1,34 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "soundcloud-plus/version"
+
+Gem::Specification.new do |s|
+  s.name        = "soundcloud-plus"
+  s.version     = SCPlus::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Benjamin Guest"]
+  s.email       = ["benguest@gmaill.com"]
+  s.homepage    = ""
+  s.summary     = %q{Lightweight wrapper for a lightweight wrapper for the soundcloud api}
+  s.description = %q{makes calling soundcloud api simpler from ruby}
+
+  s.rubyforge_project = "soundcloud-plus"
+
+  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"]
+
+  # specify any dependencies here; for example:
+
+  # General Dependency's
+  s.add_dependency "soundcloud", "~> 0.2.9"
+  s.add_dependency "active_support"
+
+  #Testing
+  s.add_development_dependency "rspec"
+
+  #Automated Testing
+  s.add_development_dependency "guard"
+  s.add_development_dependency "guard-rspec"
+end

data/spec/soundcloud-plus/functions_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+
+describe  String do
+   describe "#singular?" do
+      it { "poop".singular?.should == true }
+      it {"farts".singular?.should == false}
+   end
+end

data/spec/soundcloud-plus_spec.rb

@@ -0,0 +1,106 @@
+require 'spec_helper'
+
+describe SoundcloudPlus do 
+   PARAMS = {:client_id => "client_id", :site => "example.com", :on_exchange_token => "token"}
+
+   let(:client){SoundcloudPlus.new(PARAMS)}
+   describe "#attach" do
+      it "should be able attach random to path" do
+         client.attach("poopsticks", 1234)
+         client.path.should == "/poopsticks/1234"
+      end
+   end
+
+   describe "#resolve" do
+      before(:each){client.should_receive(:get).with("/resolve",:url => "http://example.com/poopman/poopy-track")}
+      it{ client.resolve("http://example.com/poopman/poopy-track")}
+      it{ client.resolve("poopman/poopy-track")}
+      it{ client.resolve("/poopman/poopy-track")}
+   end
+
+   describe "#fetch! (and alias)" do
+      before(:each){client.should_receive(:get).with("/tracks/1234",PARAMS)}
+      it{ client.track(1234).fetch!}
+      it{ client.tracks(1234)}
+      it{ client.track(1234).get!}
+   end
+
+   describe "#me" do
+      it "should add /me to path" do
+         client.me
+         client.path.should == "/me"
+      end
+      it "should remove other stuff from path when called" do
+         client.track(1234).me
+         client.path.should == "/me"
+      end
+   end
+
+   describe "#user" do
+      it "should add user with id" do
+         client.user(1234)
+         client.path.should == "/users/1234"
+      end
+      it "should add user with permalink only" do
+         client.stub!(:resolve).and_return(client)
+         client.stub!(:id).and_return(1234)
+         client.user("bob")
+         client.path.should == "/users/1234"
+      end
+   end
+
+   describe "#users" do
+      it "should request users" do
+         client.should_receive(:get).with("/users", PARAMS)
+         client.users
+      end
+   end
+
+   %w(user track playlist group comment app).each do |method|
+      describe "##{method}(1234)" do
+         it "should add correct thing to path" do
+            client.send(method, 1234)
+            client.path.should == "/#{method.pluralize}/1234"
+         end
+      end
+
+      describe "##{method.pluralize}" do
+         it "should add list to end of path and fetch" do
+            client.should_receive(:get).with("/#{method.pluralize}", PARAMS)
+            client.send(method.pluralize)
+         end
+      end
+   end
+
+   %w(shared_to secret_token all own exclusive).each do |method|
+      describe "##{method}" do
+         it "should add correct thing to path" do
+            client.send(method, 1234)
+            client.path.should == "/#{method.gsub('_','-')}/1234"
+         end
+      end
+   end
+
+   describe "s ability to chain calls together" do
+      it "should chain track and comment together" do
+         client.track(1234).comment(5678)
+         client.path.should == "/tracks/1234/comments/5678"
+      end
+
+   end
+
+   %w(limit order).each do |method|
+      it "should add parameter to options" do
+         client.send(method,"param")
+         client.options[method.to_sym].should == "param"
+      end
+   end
+
+   describe "#where" do
+      it "should add hash to parameters" do
+         client.where(:thing => "sweet")
+         client.options.should == PARAMS.merge({:thing => "sweet"})
+      end
+   end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,21 @@
+# spec_helper
+
+require 'rubygems'
+require 'bundler/setup'
+# Bundler.setup
+
+require 'soundcloud-plus' 
+
+require 'rspec'
+
+RSpec.configure do |config| # :nodoc: all
+   # == Mock Framework
+   # If you prefer to use mocha, flexmock or RR, uncomment the appropriate line:
+   config.mock_with :rspec
+
+   #Focus on one test with :focus
+   config.treat_symbols_as_metadata_keys_with_true_values = true
+   config.filter_run :focus => true
+   config.run_all_when_everything_filtered = true
+
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: soundcloud-plus
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Benjamin Guest
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-01-20 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: soundcloud
+  requirement: &70212389140440 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.2.9
+  type: :runtime
+  prerelease: false
+  version_requirements: *70212389140440
+- !ruby/object:Gem::Dependency
+  name: active_support
+  requirement: &70212389139660 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70212389139660
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70212389138920 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70212389138920
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: &70212389138160 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70212389138160
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: &70212389137140 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70212389137140
+description: makes calling soundcloud api simpler from ruby
+email:
+- benguest@gmaill.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- README.md
+- Rakefile
+- lib/soundcloud-plus.rb
+- lib/soundcloud-plus/functions.rb
+- lib/soundcloud-plus/version.rb
+- soundcloud-plus.gemspec
+- spec/soundcloud-plus/functions_spec.rb
+- spec/soundcloud-plus_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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: soundcloud-plus
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Lightweight wrapper for a lightweight wrapper for the soundcloud api
+test_files:
+- spec/soundcloud-plus/functions_spec.rb
+- spec/soundcloud-plus_spec.rb
+- spec/spec_helper.rb