clyp 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 272eb4aaf10f9a44dc16bfc70831b851e22276d2
+  data.tar.gz: 6e2a6d5c26161ac26dff4e66b101cc4286619620
+SHA512:
+  metadata.gz: e659faddf42462c1922885a14196fcca24159c3d2f29e668d7a7defa768620544e414f0545ea9c2fb4e1e9bffce1aea5c9d3ed11d560d2b1e4348e956a0a27d8
+  data.tar.gz: a6537358a5d9f8d2425a18b560af0d16475965450ff0a953f36274250088d846d78c1143e370cdb3796e467bd5218fffe661d4be14ebf244a3ad1c4099a6570d

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.idea
+/.idea/*

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.1

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in clypit.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,27 @@
+Copyright (c) 2015, Alexander Lozada
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+* Neither the name of tumbot nor the names of its
+  contributors may be used to endorse or promote products derived from
+  this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,86 @@
+# Clyp
+
+Clyp is an unofficial API wrapper for the audio sharing website http://clyp.it  With this gem, you can view, search, and upload your own files.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'clyp'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install clyp
+
+## Usage
+
+To use the `clyp` gem, include this in your files
+
+    require `clyp`
+
+### Uploading a file
+
+First, create a `TrackUpload` object, and set the parameters to your liking.
+
+    track = Clyp::TrackUpload.new(file: File.new('../test/files/sample.mp3'), title: 'Test', description: '#cool test')
+
+Create a client object to manage the API.
+
+    client = Clyp::Client.new
+
+Finally, Pass in your `TrackUpload` object
+
+    my_upload = client.upload(track)
+
+The upload function will return a `TrackUser` object.  For instance, to access the new `url`, perform the following
+
+    my_upload.url
+    >> https://clyp.it/qvneogei
+
+You can also access direct MP3 links, the date uploaded, and more.
+
+
+### More API functions
+
+Search for tracks:
+
+    client = Clyp::Client.new
+    client.search 'guitar'
+
+Get random tracks:
+
+    client = Clyp::Client.new
+    client.random(count: 5)
+
+Get popular tracks:
+
+    client = Clyp::Client.new
+    client.popular(count: 3)
+
+Chain functions:
+
+    client = Clyp::Client.new
+    client.get(id: client.search('piano').first.id)
+
+There are more functions available in the documentation.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/piedoom/clyp/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "clyp"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/clyp.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'clyp/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "clyp"
+  spec.version       = Clyp::VERSION
+  spec.authors       = ["Alexander Lozada"]
+  spec.email         = ["alexanderpaullozada@gmail.com"]
+
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  end
+
+  spec.summary       = %q{An API wrapper for the audio sharing website, clyp.it}
+  spec.homepage      = "https://github.com/piedoom/clyp-ruby"
+  spec.license       = "BSD-3-Clause"
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.8"
+  spec.add_development_dependency "rake", "~> 10.0"
+
+  spec.add_development_dependency "vcr"
+  spec.add_development_dependency "webmock"
+  spec.add_dependency "faraday"
+  spec.add_dependency "rest-client"
+  spec.add_dependency "json"
+end

data/lib/clyp.rb

@@ -0,0 +1,9 @@
+require_relative "clyp/version"
+require_relative 'clyp/client'
+require_relative 'clyp/track'
+require_relative 'clyp/track_upload'
+require_relative 'clyp/track_user'
+require_relative 'clyp/soundwave'
+require_relative 'clyp/list_item'
+require 'faraday'
+

data/lib/clyp/client.rb

@@ -0,0 +1,105 @@
+require 'json'
+require 'rest-client'
+API_BASE = "https://api.clyp.it"
+UPLOAD_BASE = "https://upload.clyp.it/upload"
+
+module Clyp
+  class Client
+    # uploads a TrackUpload object, returns a TrackUser object
+    def upload track
+      if track.playlist_id and track.playlist_token
+        response = JSON.parse(RestClient.post(UPLOAD_BASE, audioFile: track.file, title: track.title, playlistId: track.playlist_id,
+                  playlistUploadToken: track.playlist_token, order: track.order, description: track.description,
+                  longitude: track.longitude, latitude: track.latitude))
+      else
+        response = JSON.parse(RestClient.post(UPLOAD_BASE, audioFile: track.file, title: track.title,
+                  order: track.order, description: track.description, longitude: track.longitude, latitude: track.latitude))
+      end
+      TrackUser.new(response)
+    end
+
+    # get song with specific id
+    def get (id:)
+      response = Faraday.get("#{API_BASE}/#{id}")
+      attributes = JSON.parse(response.body)
+      Track.new(attributes)
+    end
+
+    # returns a Soundwave object with peak data
+    def soundwave (id:)
+      response = Faraday.get("#{API_BASE}/#{id}/soundwave")
+      attributes = JSON.parse(response.body)
+      Soundwave.new(attributes)
+    end
+
+    # returns an array of ListItem objects of categories
+    def category_list
+      response = Faraday.get("#{API_BASE}/categorylist")
+      attributes = JSON.parse(response.body)
+      result = Array.new
+      attributes.each do |attrs|
+        result << ListItem.new(attrs)
+      end
+      result
+    end
+
+    # returns 20 tracks from a specified search in an array of Track objects
+    def search term
+      response = Faraday.get("#{API_BASE}/categorylist/#{term}")
+      attributes = JSON.parse(response.body)
+      assemble_tracks attributes
+    end
+
+    # returns featured tracks in an array of Track objects
+    def featured (count: 10)
+      response = Faraday.get("#{API_BASE}/featuredlist/featured?count=#{count}")
+      attributes = JSON.parse(response.body)
+      assemble_tracks attributes
+    end
+
+    # returns popular tracks in an array of Track objects
+    def popular (count: 10)
+      response = Faraday.get("#{API_BASE}/featuredlist/popular?count=#{count}")
+      attributes = JSON.parse(response.body)
+      assemble_tracks attributes
+    end
+
+    # returns random tracks in an array of Track objects
+    def random (count: 10)
+      response = Faraday.get("#{API_BASE}/featuredlist/random?count=#{count}")
+      attributes = JSON.parse(response.body)
+      assemble_tracks attributes
+    end
+
+    # returns recent tracks in an array of Track objects
+    def recent (count: 10)
+      response = Faraday.get("#{API_BASE}/featuredlist/recent?count=#{count}")
+      attributes = JSON.parse(response.body)
+      assemble_tracks attributes
+    end
+
+    # TODO:
+    #def get_playlist (id: )
+    #  response = Faraday.get("#{API_BASE}/playlist/#{id}")
+    #  attributes = JSON.parse(response.body)
+    #end
+
+    # returns an array of nearby tracks
+    def featured_nearby (count: 10, longitude: 0, latitude: 0)
+      response = Faraday.get("#{API_BASE}/featuredlist/nearby?count=#{count}&longitude=#{longitude}&latitude=#{latitude}")
+      attributes = JSON.parse(response.body)
+      assemble_tracks attributes
+    end
+
+    private
+
+    def assemble_tracks attributes
+      result = Array.new
+      attributes.each do |attrs|
+        result << Track.new(attrs)
+      end
+      result
+    end
+
+  end
+end

data/lib/clyp/list_item.rb

@@ -0,0 +1,11 @@
+module Clyp
+  class ListItem
+    VALID_OPTIONS_KEYS = [:title, :location]
+    attr_accessor *VALID_OPTIONS_KEYS
+
+    def initialize(t)
+      @title =           t['Title']
+      @location =        t['Location']
+    end
+  end
+end

data/lib/clyp/soundwave.rb

@@ -0,0 +1,10 @@
+module Clyp
+  class Soundwave
+    VALID_OPTIONS_KEYS = [:data]
+    attr_accessor *VALID_OPTIONS_KEYS
+
+    def initialize(t)
+      @data =           t
+    end
+  end
+end

data/lib/clyp/track.rb

@@ -0,0 +1,26 @@
+module Clyp
+  class Track
+    VALID_OPTIONS_KEYS = [:status, :comments_enabled, :category, :id, :title, :description, :duration, :url, :url_secure_mp3,
+                          :url_mp3, :url_ogg, :url_secure_ogg, :longitude, :latitude, :date]
+    attr_accessor *VALID_OPTIONS_KEYS
+
+    def initialize(t={})
+      @status =           t['Status']
+      @comments_enabled = t['CommentsEnabled']
+      @category =         t['Category']
+      @id =               t['AudioFileId']
+      @title =            t['Title']
+      @description =      t['Description']
+      @duration =         t['Duration']
+      @url =              t['Url']
+      @url_mp3 =          t['Mp3Url']
+      @url_secure_mp3 =   t['SecureMp3Url']
+      @url_ogg =          t['OggUrl']
+      @url_secure_ogg =   t['SecureOggUrl']
+      @longitude =        t['Longitude']
+      @latitude =         t['Latitude']
+      @date =             t['DateCreated']
+    end
+
+  end
+end

data/lib/clyp/track_upload.rb

@@ -0,0 +1,18 @@
+module Clyp
+  class TrackUpload
+    VALID_OPTIONS_KEYS = [:file, :playlist_id, :playlist_token, :order, :description, :longitude, :latitude, :title]
+    attr_accessor *VALID_OPTIONS_KEYS
+
+    def initialize(t={})
+      @file =                 t[:file]
+      @playlist_id =          t[:playlist_id]
+      @playlist_token =       t[:playlist_token]
+      @order =                t[:order]
+      @description =          t[:description]
+      @longitude =            t[:longitude]
+      @latitude =             t[:latitude]
+      @title =                t[:title]
+    end
+
+  end
+end

data/lib/clyp/track_user.rb

@@ -0,0 +1,14 @@
+module Clyp
+  VALID_OPTIONS_KEYS = [:successful, :message, :playlist_id, :playlist_token]
+  attr_accessor *VALID_OPTIONS_KEYS
+
+  class TrackUser < Track
+    def initialize t
+      super(t)
+      @successful      = t[:successful]
+      @message         = t[:message]
+      @playlist_id     = t[:playlist_id]
+      @playlist_token  = t[:playlist_token]
+    end
+  end
+end

data/lib/clyp/version.rb

@@ -0,0 +1,3 @@
+module Clyp
+  VERSION = "0.1.1"
+end

metadata

@@ -0,0 +1,160 @@
+--- !ruby/object:Gem::Specification
+name: clyp
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Alexander Lozada
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-01-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.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: 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: 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: rest-client
+  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:
+- alexanderpaullozada@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- clyp.gemspec
+- lib/clyp.rb
+- lib/clyp/client.rb
+- lib/clyp/list_item.rb
+- lib/clyp/soundwave.rb
+- lib/clyp/track.rb
+- lib/clyp/track_upload.rb
+- lib/clyp/track_user.rb
+- lib/clyp/version.rb
+homepage: https://github.com/piedoom/clyp-ruby
+licenses:
+- BSD-3-Clause
+metadata:
+  allowed_push_host: https://rubygems.org
+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.4.6
+signing_key: 
+specification_version: 4
+summary: An API wrapper for the audio sharing website, clyp.it
+test_files: []