siilar 1.0.0.pre

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5f06b4bdcda7a709d1f1e6e065eb88315abffc1c
+  data.tar.gz: ef394621c6c509e794e7c8465bd60215d8f409fd
+SHA512:
+  metadata.gz: 5862668d5246a2cff2ea72354083f435b708a396282e6604e2940491294d4d6f820e4852f42fb61a3908ae7ee0df8b79a728566528fcbec17ee3ba8c1b464da5
+  data.tar.gz: 2c0ba73ad89122416a6a5203745b976cdcb4d126a1d579ccd070b0da815b61c29ddef45f5b261a2f4756e06c85d223b860cab56f8258cebdfe113e90fc9f2baa

data/.gitignore

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

data/.rspec

@@ -0,0 +1 @@
+--color

data/.ruby-version

@@ -0,0 +1 @@
+2.2.1

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 2.2.1
+
+notifications:
+  email: false

data/Gemfile

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

data/README.md

@@ -0,0 +1,53 @@
+# Siilar Ruby Client [![Build Status](https://travis-ci.org/craftsmen/niland-siilar-ruby.svg?branch=better-methods-names)](https://travis-ci.org/craftsmen/niland-siilar-ruby)
+
+A Ruby client for the [Siilar API](http://api.siilar.com/1.0/doc/).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'siilar'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install siilar
+
+## Usage
+
+This library is a Ruby client you can use to interact with the [Siilar API](http://api.siilar.com/1.0/doc/).
+
+Here's a short example.
+
+```ruby
+require 'siilar'
+
+client = Siilar::Client.new(api_key: 'YOUR_KEY')
+
+# Create a track
+track = client.tracks.create(title: 'Nine Lives', external_id: '123')
+puts "Track: %s (id: %d)" % [track.title, track.id]
+
+# Search for similar tracks
+tracks = client.search.similar(similar_ids: '1234')
+tracks.each do |track|
+  puts "Track: %s (id: %d)" % [track.title, track.id]
+end
+```
+
+## 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/craftsmen/niland-siilar-ruby/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,10 @@
+require 'bundler/gem_tasks'
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new do |t|
+  t.verbose = !!ENV['VERBOSE']
+end
+
+task test: :spec
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "siilar"
+
+# 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/lib/siilar/client/clients.rb

@@ -0,0 +1,27 @@
+module Siilar
+  class Client
+
+    def tracks
+      @services[:tracks] ||= Client::TracksService.new(self)
+    end
+
+    def search
+      @services[:search] ||= Client::SearchService.new(self)
+    end
+
+    class ClientService < ::Struct.new(:client)
+    end
+
+    require 'siilar/client/tracks'
+
+    class TracksService < ClientService
+      include Client::Tracks
+    end
+
+    require 'siilar/client/search'
+
+    class SearchService < ClientService
+      include Client::Search
+    end
+  end
+end

data/lib/siilar/client/search.rb

@@ -0,0 +1,16 @@
+module Siilar
+  class Client
+    module Search
+
+      # Search for a track
+      #
+      # @see http://api.siilar.com/1.0/doc/search-and-analyze#search
+      def similar(query = {})
+        options = { query: query }
+        response = client.get('1.0/search', options)
+
+        response.map { |r| Struct::Track.new(r) }
+      end
+    end
+  end
+end

data/lib/siilar/client/tracks.rb

@@ -0,0 +1,41 @@
+module Siilar
+  class Client
+    module Tracks
+
+      # Gets a track.
+      #
+      # @see http://api.siilar.com/1.0/doc/tracks#get-a-track
+      def track(track)
+        response = client.get("1.0/tracks/#{track}")
+
+        Struct::track.new(response)
+      end
+
+      # Creates a track.
+      #
+      # @see http://api.siilar.com/1.0/doc/tracks#create-a-track
+      def create(attributes = {})
+        Extra.validate_mandatory_attributes(attributes, [:title, :external_id])
+        response = client.post('1.0/tracks', attributes)
+
+        Struct::Track.new(response)
+      end
+
+      # Updates a track.
+      #
+      # @see http://api.siilar.com/1.0/doc/tracks#edit-a-track
+      def update(track, attributes = {})
+        response = client.patch("1.0/tracks/#{track}", attributes)
+
+        Struct::Track.new(response)
+      end
+
+      # Deletes a track.
+      #
+      # @see http://api.siilar.com/1.0/doc/tracks#delete-a-track
+      def delete(track)
+        client.delete("1.0/tracks/#{track}")
+      end
+    end
+  end
+end

data/lib/siilar/client.rb

@@ -0,0 +1,87 @@
+require 'siilar/extra'
+require 'siilar/struct'
+require 'siilar/client/clients'
+
+module Siilar
+  class Client
+    attr_accessor :api_endpoint, :api_key, :user_agent
+
+    def initialize(options = {})
+      defaults = Siilar::Default.options
+
+      Siilar::Default.keys.each do |key|
+        instance_variable_set(:"@#{key}", options[key] || defaults[key])
+      end
+
+      @services = {}
+    end
+
+    def get(path, options = {})
+      execute :get, path, options
+    end
+
+    def post(path, options = {})
+      execute :post, path, options
+    end
+
+    def patch(path, options = {})
+      execute :patch, path, options
+    end
+
+    def delete(path, options = {})
+      execute :delete, path, options
+    end
+
+    def execute(method, path, data, options = {})
+      response = request(method, path, data, options)
+
+      case response.code
+      when 200..299
+        response
+      when 401
+        raise AuthenticationFailed, response['message']
+      when 404
+        raise NotFoundError.new(response)
+      else
+        raise RequestError.new(response)
+      end
+    end
+
+    def request(method, path, data, options = {})
+      if data.is_a?(Hash)
+        options[:query] = data.delete(:query) if data.key?(:query)
+        options[:headers] = data.delete(:headers) if data.key?(:headers)
+      end
+      if !data.empty?
+        options[:body] = data.to_json
+      end
+
+      HTTParty.send(method, api_endpoint + path, Extra.deep_merge!(base_options, options))
+    end
+
+    def api_endpoint
+      File.join(@api_endpoint, '')
+    end
+
+    private
+
+    def base_options
+      options = {
+        format: :json,
+        headers: {
+          'Accept' => 'application/json',
+          'Content-type' => 'application/json',
+          'User-Agent' => user_agent
+        }
+      }
+
+      if api_key
+        options.merge!(query: { key: api_key })
+      else
+        raise Error, 'An API key is required for all API requests.'
+      end
+
+      options
+    end
+  end
+end

data/lib/siilar/default.rb

@@ -0,0 +1,28 @@
+module Siilar
+  module Default
+    API_ENDPOINT = "http://api.siilar.com/".freeze
+    USER_AGENT = "niland-siilar-ruby/#{VERSION}".freeze
+
+    class << self
+      def keys
+        @keys ||= [:api_endpoint, :api_key, :user_agent]
+      end
+
+      def options
+        Hash[keys.map { |key| [key, send(key)] }]
+      end
+
+      def api_endpoint
+        ENV['SIILAR_API_ENDPOINT'] || API_ENDPOINT
+      end
+
+      def api_key
+        ENV['SIILAR_API_KEY']
+      end
+
+      def user_agent
+        ENV['SIILAR_USER_AGENT'] || USER_AGENT
+      end
+    end
+  end
+end

data/lib/siilar/error.rb

@@ -0,0 +1,22 @@
+module Siilar
+  class Error < StandardError
+  end
+
+  class RequestError < Error
+    attr_reader :response
+
+    def initialize(response)
+      @response = response
+      super("#{response.code}")
+    end
+  end
+
+  class NotFoundError < RequestError
+  end
+
+  class AuthenticationError < Error
+  end
+
+  class AuthenticationFailed < AuthenticationError
+  end
+end

data/lib/siilar/extra.rb

@@ -0,0 +1,48 @@
+module Siilar
+  module Extra
+
+    # Returns a new hash with `self` and `other` merged recursively.
+    #
+    #   h1 = { a: true, b: { c: [1, 2, 3] } }
+    #   h2 = { a: false, b: { x: [3, 4, 5] } }
+    #
+    #   h1.deep_merge(h2) #=> { a: false, b: { c: [1, 2, 3], x: [3, 4, 5] } }
+    #
+    # Like with Hash#merge in the standard library, a block can be provided
+    # to merge values:
+    #
+    #   h1 = { a: 100, b: 200, c: { c1: 100 } }
+    #   h2 = { b: 250, c: { c1: 200 } }
+    #   h1.deep_merge(h2) { |key, this_val, other_val| this_val + other_val }
+    #   # => { a: 100, b: 450, c: { c1: 300 } }
+    def self.deep_merge(this, other, &block)
+      deep_merge!(this.dup, other, &block)
+    end
+
+    # Same as `deep_merge`, but modifies `self`.
+    def self.deep_merge!(this, other, &block)
+      other.each_pair do |current_key, other_value|
+        this_value = this[current_key]
+
+        this[current_key] = if this_value.is_a?(Hash) && other_value.is_a?(Hash)
+          deep_merge(this_value, other_value, &block)
+        else
+          if block_given? && key?(current_key)
+            block.call(current_key, this_value, other_value)
+          else
+            other_value
+          end
+        end
+      end
+
+      this
+    end
+
+    # Validates the presence of mandatory attributes.
+    def self.validate_mandatory_attributes(attributes, required)
+      required.each do |name|
+        attributes.key?(name) or raise(ArgumentError, ":#{name} is required")
+      end
+    end
+  end
+end

data/lib/siilar/struct/album.rb

@@ -0,0 +1,8 @@
+module Siilar
+  module Struct
+
+    class Album < Base
+      attr_accessor :name
+    end
+  end
+end

data/lib/siilar/struct/artist.rb

@@ -0,0 +1,8 @@
+module Siilar
+  module Struct
+
+    class Artist < Base
+      attr_accessor :name
+    end
+  end
+end

data/lib/siilar/struct/track.rb

@@ -0,0 +1,28 @@
+module Siilar
+  module Struct
+
+    class Track < Base
+      attr_accessor :id, :hash, :title, :popularity, :duration, :external_id, :isrc, :waveform_url
+
+      def album
+        @album ||= {}
+      end
+
+      def album=(attrs)
+        if attrs
+          @album = Struct::Album.new(attrs)
+        end
+      end
+
+      def artist
+        @artist ||= {}
+      end
+
+      def artist=(attrs)
+        if attrs
+          @artist = Struct::Artist.new(attrs)
+        end
+      end
+    end
+  end
+end

data/lib/siilar/struct.rb

@@ -0,0 +1,17 @@
+module Siilar
+  module Struct
+
+    class Base
+      def initialize(attributes = {})
+        attributes.each do |key, value|
+          m = "#{key}=".to_sym
+          self.send(m, value) if self.respond_to?(m)
+        end
+      end
+    end
+  end
+end
+
+require 'siilar/struct/track'
+require 'siilar/struct/album'
+require 'siilar/struct/artist'

data/lib/siilar/version.rb

@@ -0,0 +1,3 @@
+module Siilar
+  VERSION = '1.0.0.pre'
+end

data/lib/siilar.rb

@@ -0,0 +1,10 @@
+require 'httparty'
+
+module Siilar
+  # Your code goes here...
+end
+
+require 'siilar/version'
+require 'siilar/default'
+require 'siilar/client'
+require 'siilar/error'

data/siilar.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'siilar/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'siilar'
+  spec.version       = Siilar::VERSION
+  spec.authors       = ['Mehdi Lahmam']
+  spec.email         = ['mehdi@craftsmen.io']
+
+  spec.summary       = 'A Ruby client for the Siilar API'
+  spec.description   = 'A Ruby client for the Siilar API'
+  spec.homepage      = 'https://github.com/craftsmen/niland-siilar-ruby'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency  'httparty'
+
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'webmock'
+end

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: siilar
+version: !ruby/object:Gem::Version
+  version: 1.0.0.pre
+platform: ruby
+authors:
+- Mehdi Lahmam
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  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: 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: rspec
+  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'
+description: A Ruby client for the Siilar API
+email:
+- mehdi@craftsmen.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/siilar.rb
+- lib/siilar/client.rb
+- lib/siilar/client/clients.rb
+- lib/siilar/client/search.rb
+- lib/siilar/client/tracks.rb
+- lib/siilar/default.rb
+- lib/siilar/error.rb
+- lib/siilar/extra.rb
+- lib/siilar/struct.rb
+- lib/siilar/struct/album.rb
+- lib/siilar/struct/artist.rb
+- lib/siilar/struct/track.rb
+- lib/siilar/version.rb
+- siilar.gemspec
+homepage: https://github.com/craftsmen/niland-siilar-ruby
+licenses: []
+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: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: A Ruby client for the Siilar API
+test_files: []
+has_rdoc: