tunefish_client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 04c2c671d23cc9e68be66d4d4873f041ed447387
+  data.tar.gz: e54530eae5f2d5745e2e97d959c5b860a877ed37
+SHA512:
+  metadata.gz: 73fd84841008d05cda427b989437d2e45613b91701c30c2cae12e2edcb68d1606c007877d7e7da823768c0b75de950647fae01c32e96aa4ff6718d1b1ed3a865
+  data.tar.gz: 743718cf19a23d1204eb158fc8930c7e51660998cb2a3410010e8616c3b822b683507919c98cbce12c3ebaa38041dcf67cfc689de413ff4471872be6ba978819

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Will Faurot
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,47 @@
+# Tunefish Client
+
+A client for the [Tunefish](https://github.com/tyrbo/tunefish) RESTful API.  Tunefish is a music aggregation service that lets users link accounts from services like Soundcloud and Youtube, and populates an activity feed with relevant new music.  "Activities" are either youtube videos, soundcloud tracks, or tweets with the hashtag "#tf".  The Tunefish API currently supports users and activities.  You can find:
+
+* All activities
+* Activities for a given user
+* All users
+* Information for a specific user
+
+## Installation
+
+Add it to your Gemfile:
+
+`gem 'tunefish'`
+
+Bundle:
+
+`$ bundle`
+
+Or install it yourself as:
+
+`$ gem install tunefish`
+
+## Usage
+
+Instantiate a new client specifying the API version like so:
+
+```ruby
+require 'tunefish_client'
+
+client = TunefishClient::Client.new(version: "v1")
+
+# retrieve a list of user objects
+client.users
+
+# retrieve a single user's information
+user_id = 1
+client.user(user_id)
+
+# retrieve a list of activities
+client.activities
+
+# retrieve a list of activities for a given user
+user_id = 1
+client.user_activitites(user_id)
+```
+

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require 'bundler'
+Bundler.require
+
+task :test do
+  Dir.glob('./test/**/*_test.rb') { |file| require file }
+end
+

data/lib/tunefish_client.rb

@@ -0,0 +1,4 @@
+require "tunefish_client/version"
+
+module TunefishClient
+end

data/lib/tunefish_client/activity.rb

@@ -0,0 +1,9 @@
+class Activity
+  attr_reader :id, :url, :provider
+  
+  def initialize(data)
+    @id = data["id"]
+    @url = data["url"]
+    @provider = data["provider"]
+  end
+end

data/lib/tunefish_client/client.rb

@@ -0,0 +1,53 @@
+require 'faraday'
+require 'json'
+require_relative 'user'
+require_relative 'activity'
+
+module TunefishClient
+  class Client
+    attr_reader :connection
+
+    def initialize(host: "http://tunefi.sh", version: "v1")
+      @connection = Faraday.new(url: host)
+      @version = version
+    end
+
+    def user(id)
+      response = connection.get("#{base_url}/users/#{id}")
+      data = parse_response_body(response.body)
+      User.new(data["user"])
+    end
+
+    def users
+      response = connection.get("#{base_url}/users")
+      data = parse_response_body(response.body)
+      data["users"].map { |user_data| User.new(user_data) }
+    end
+
+    def user_activities(id)
+      response = connection.get("#{base_url}/users/#{id}/activities")
+      data = parse_response_body(response.body)
+      build_activity_objects(data["activities"])
+    end
+
+    def activities
+      response = connection.get("#{base_url}/activities")
+      data = parse_response_body(response.body)
+      build_activity_objects(data["activities"])
+    end
+
+    private
+
+      def parse_response_body(body)
+        JSON.parse(body)
+      end
+
+      def base_url
+        "/api/#{@version}"
+      end
+
+      def build_activity_objects(activities)
+        activities.map { |activity_data| Activity.new(activity_data) }
+      end
+  end
+end

data/lib/tunefish_client/user.rb

@@ -0,0 +1,10 @@
+class User
+  attr_reader :name, :id, :photo, :activity_ids
+
+  def initialize(data)
+    @name  = data["name"]
+    @id    = data["id"]
+    @photo = data["photo"]
+    @activity_ids = data["activity_ids"]
+  end
+end

data/lib/tunefish_client/version.rb

@@ -0,0 +1,3 @@
+module TunefishClient
+  VERSION = "0.1.0"
+end

data/test/fixtures/vcr_cassettes/activities.yml

@@ -0,0 +1,48 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://localhost:3000/api/v1/activities
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v0.9.0
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Xss-Protection:
+      - 1; mode=block
+      X-Content-Type-Options:
+      - nosniff
+      Access-Control-Allow-Origin:
+      - "*"
+      Access-Control-Request-Method:
+      - "*"
+      Content-Type:
+      - application/json; charset=utf-8
+      Etag:
+      - '"4d71ad78b0da2881b5b98be9d53bd686"'
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      X-Request-Id:
+      - e358e792-8cc1-4957-84b1-6ea48c4f558c
+      X-Runtime:
+      - '0.108539'
+      Transfer-Encoding:
+      - chunked
+    body:
+      encoding: UTF-8
+      string: '{"activities":[{"id":3,"url":"http://www.youtube.com/embed/XGSy3_Czz8k","user_id":2,"created_at":"2014-11-13T02:32:01.753Z","updated_at":"2014-11-13T02:32:01.753Z","provider":"youtube"},{"id":4,"url":"https://w.soundcloud.com/player/?url=https%3A//api.soundcloud.com/tracks/143444724\u0026amp;auto_play=false\u0026amp;hide_related=false\u0026amp;show_comments=true\u0026amp;show_user=true\u0026amp;show_reposts=false\u0026amp;visual=true","user_id":2,"created_at":"2014-11-13T02:36:08.796Z","updated_at":"2014-11-13T02:36:08.796Z","provider":"soundcloud"},{"id":5,"url":null,"user_id":2,"created_at":"2014-11-13T02:39:52.541Z","updated_at":"2014-11-13T02:39:52.541Z","provider":"soundcloud"}]}'
+    http_version: 
+  recorded_at: Thu, 13 Nov 2014 03:12:17 GMT
+recorded_with: VCR 2.9.3

data/test/fixtures/vcr_cassettes/user.yml

@@ -0,0 +1,48 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://localhost:3000/api/v1/users/2
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v0.9.0
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Xss-Protection:
+      - 1; mode=block
+      X-Content-Type-Options:
+      - nosniff
+      Access-Control-Allow-Origin:
+      - "*"
+      Access-Control-Request-Method:
+      - "*"
+      Content-Type:
+      - application/json; charset=utf-8
+      Etag:
+      - '"e0ebc772720f232807e86e359e33c2ed"'
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      X-Request-Id:
+      - 918738be-6656-4e7b-b309-5acc990dda62
+      X-Runtime:
+      - '0.764081'
+      Transfer-Encoding:
+      - chunked
+    body:
+      encoding: UTF-8
+      string: '{"user":{"id":2,"name":"John Doe","photo":null,"activity_ids":[3,4,5]},"activities":[{"id":3,"url":"http://www.youtube.com/embed/XGSy3_Czz8k","user_id":2,"created_at":"2014-11-13T02:32:01.753Z","updated_at":"2014-11-13T02:32:01.753Z","provider":"youtube"},{"id":4,"url":"https://w.soundcloud.com/player/?url=https%3A//api.soundcloud.com/tracks/143444724\u0026amp;auto_play=false\u0026amp;hide_related=false\u0026amp;show_comments=true\u0026amp;show_user=true\u0026amp;show_reposts=false\u0026amp;visual=true","user_id":2,"created_at":"2014-11-13T02:36:08.796Z","updated_at":"2014-11-13T02:36:08.796Z","provider":"soundcloud"},{"id":5,"url":null,"user_id":2,"created_at":"2014-11-13T02:39:52.541Z","updated_at":"2014-11-13T02:39:52.541Z","provider":"soundcloud"}]}'
+    http_version: 
+  recorded_at: Thu, 13 Nov 2014 02:47:44 GMT
+recorded_with: VCR 2.9.3

data/test/fixtures/vcr_cassettes/user_activities.yml

@@ -0,0 +1,48 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://localhost:3000/api/v1/users/2/activities
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v0.9.0
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Xss-Protection:
+      - 1; mode=block
+      X-Content-Type-Options:
+      - nosniff
+      Access-Control-Allow-Origin:
+      - "*"
+      Access-Control-Request-Method:
+      - "*"
+      Content-Type:
+      - application/json; charset=utf-8
+      Etag:
+      - '"4d71ad78b0da2881b5b98be9d53bd686"'
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      X-Request-Id:
+      - 580f5f1f-988d-4ee8-8221-ebc0777d8497
+      X-Runtime:
+      - '0.162024'
+      Transfer-Encoding:
+      - chunked
+    body:
+      encoding: UTF-8
+      string: '{"activities":[{"id":3,"url":"http://www.youtube.com/embed/XGSy3_Czz8k","user_id":2,"created_at":"2014-11-13T02:32:01.753Z","updated_at":"2014-11-13T02:32:01.753Z","provider":"youtube"},{"id":4,"url":"https://w.soundcloud.com/player/?url=https%3A//api.soundcloud.com/tracks/143444724\u0026amp;auto_play=false\u0026amp;hide_related=false\u0026amp;show_comments=true\u0026amp;show_user=true\u0026amp;show_reposts=false\u0026amp;visual=true","user_id":2,"created_at":"2014-11-13T02:36:08.796Z","updated_at":"2014-11-13T02:36:08.796Z","provider":"soundcloud"},{"id":5,"url":null,"user_id":2,"created_at":"2014-11-13T02:39:52.541Z","updated_at":"2014-11-13T02:39:52.541Z","provider":"soundcloud"}]}'
+    http_version: 
+  recorded_at: Thu, 13 Nov 2014 03:02:12 GMT
+recorded_with: VCR 2.9.3

data/test/fixtures/vcr_cassettes/users.yml

@@ -0,0 +1,49 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://localhost:3000/api/v1/users
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v0.9.0
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Xss-Protection:
+      - 1; mode=block
+      X-Content-Type-Options:
+      - nosniff
+      Access-Control-Allow-Origin:
+      - "*"
+      Access-Control-Request-Method:
+      - "*"
+      Content-Type:
+      - application/json; charset=utf-8
+      Etag:
+      - '"11197fca87aa2104bf3418f093792c83"'
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      X-Request-Id:
+      - c541d0d7-79a6-4262-8196-eecbbbc502be
+      X-Runtime:
+      - '0.100882'
+      Transfer-Encoding:
+      - chunked
+    body:
+      encoding: UTF-8
+      string: '{"users":[{"id":2,"name":"John Doe","photo":null,"activity_ids":[3,4,5]},{"id":3,"name":"Jane
+        Doe","photo":null,"activity_ids":[]},{"id":4,"name":"Jon Snow","photo":null,"activity_ids":[]}],"activities":[{"id":3,"url":"http://www.youtube.com/embed/XGSy3_Czz8k","user_id":2,"created_at":"2014-11-13T02:32:01.753Z","updated_at":"2014-11-13T02:32:01.753Z","provider":"youtube"},{"id":4,"url":"https://w.soundcloud.com/player/?url=https%3A//api.soundcloud.com/tracks/143444724\u0026amp;auto_play=false\u0026amp;hide_related=false\u0026amp;show_comments=true\u0026amp;show_user=true\u0026amp;show_reposts=false\u0026amp;visual=true","user_id":2,"created_at":"2014-11-13T02:36:08.796Z","updated_at":"2014-11-13T02:36:08.796Z","provider":"soundcloud"},{"id":5,"url":null,"user_id":2,"created_at":"2014-11-13T02:39:52.541Z","updated_at":"2014-11-13T02:39:52.541Z","provider":"soundcloud"}]}'
+    http_version: 
+  recorded_at: Thu, 13 Nov 2014 02:54:17 GMT
+recorded_with: VCR 2.9.3

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+require 'minitest/autorun'
+require 'minitest/pride'
+require 'webmock/minitest'
+require 'vcr'
+
+VCR.configure do |c|
+  c.cassette_library_dir = 'test/fixtures/vcr_cassettes'
+  c.hook_into :webmock
+end
+

data/test/tunefish_test.rb

@@ -0,0 +1,54 @@
+require './lib/tunefish_client/client'
+require_relative 'test_helper'
+
+class TunefishClientTest < Minitest::Test
+  def setup
+    @client = TunefishClient::Client.new(host: 'http://localhost:3000')
+  end
+
+  def test_it_exists
+    assert TunefishClient::Client
+  end
+
+  def test_it_finds_a_user
+    VCR.use_cassette('user') do
+      user = @client.user(2)
+      assert_equal "John Doe", user.name
+    end
+  end
+
+  def test_it_finds_all_users
+    VCR.use_cassette('users') do
+      users = @client.users
+      assert_equal "John Doe", users.first.name
+    end
+  end
+
+  def test_it_finds_activity_for_a_user
+    VCR.use_cassette('user_activities') do
+      activities = @client.user_activities(2)
+      assert_equal "youtube", activities.first.provider
+    end
+  end
+
+  def test_it_finds_all_activity
+    VCR.use_cassette('activities') do
+      activities = @client.activities
+      assert_equal "youtube", activities.first.provider
+    end
+  end
+
+  class UserTest < Minitest::Test
+    def test_it_exists_and_has_attributes
+      user = User.new("name" => "John Doe", "photo" => "example.com/img", "id" => "1", "activity_ids" => ["1", "2"])
+      assert_equal "John Doe", user.name
+    end
+  end
+
+  class ActivityTest < Minitest::Test
+    def test_it_exists_and_has_attributes
+      activity = Activity.new("id" => "1", "url" => "http://aurl.com", "provider" => "youtube")
+      assert_equal "youtube", activity.provider
+    end
+  end
+end

data/tunefish_client.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'tunefish_client/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "tunefish_client"
+  spec.version       = TunefishClient::VERSION
+  spec.authors       = ["Will Faurot"]
+  spec.email         = ["wfaurot@gmail.com"]
+  spec.summary       = "Client for the Tunefish RESTful API."
+  spec.description   = ""
+  spec.homepage      = "http://tunefi.sh"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "webmock"
+  spec.add_development_dependency "vcr"
+  spec.add_dependency "faraday"
+  spec.add_dependency "json"
+end

metadata

@@ -0,0 +1,166 @@
+--- !ruby/object:Gem::Specification
+name: tunefish_client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Will Faurot
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ''
+email:
+- wfaurot@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/tunefish_client.rb
+- lib/tunefish_client/activity.rb
+- lib/tunefish_client/client.rb
+- lib/tunefish_client/user.rb
+- lib/tunefish_client/version.rb
+- test/fixtures/vcr_cassettes/activities.yml
+- test/fixtures/vcr_cassettes/user.yml
+- test/fixtures/vcr_cassettes/user_activities.yml
+- test/fixtures/vcr_cassettes/users.yml
+- test/test_helper.rb
+- test/tunefish_test.rb
+- tunefish_client.gemspec
+homepage: http://tunefi.sh
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Client for the Tunefish RESTful API.
+test_files:
+- test/fixtures/vcr_cassettes/activities.yml
+- test/fixtures/vcr_cassettes/user.yml
+- test/fixtures/vcr_cassettes/user_activities.yml
+- test/fixtures/vcr_cassettes/users.yml
+- test/test_helper.rb
+- test/tunefish_test.rb
+has_rdoc: