acoustid-api 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    OTNhNzg1MTY2MTgyNTEyYWFjZTQzYzAyNjQ0NzA1YzQyNTQ1ZTU0YQ==
+  data.tar.gz: !binary |-
+    OWQ1ZTBhNTE1OGUwZGMxYTRhYTU1ZjRlMWI4OTRiYWE4Y2EyZTI1MQ==
+SHA512:
+  metadata.gz: !binary |-
+    MDczMTBjMmYxOTlmOGQ4ZDI2MTMyODc5MGQyNGVhZGQ1MDY2N2Y4MWNmNTY4
+    MmUwZTMxZDMyZTE2YmYyNTFkYmI5MjQ1YzYxZjRkOTAzZmE3NjYyNGNhOGZi
+    YWIxZDU5YzUzMzVhOWUzOTYwZDYwNWNmM2U1ODM3YzBhODI3ZTU=
+  data.tar.gz: !binary |-
+    Zjk1OGE5OTJmYjljOTc4N2U1MWNkODZjNzdiODY1MjBhZWNkNWMxNjkyNjJj
+    OTJlZTgxMjBiNTI4N2Q3MDcxNTVlOTQyNDg4ZTY3MDI5Yzc4NGE4MzJlZmZk
+    YjI2Y2Q0M2IwM2IxMmJkNzQ3Njk1OTFhMjZhYzM5NDY0ZTI4Zjc=

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,22 @@
+PATH
+  remote: .
+  specs:
+    acoustid-api (0.0.0)
+      httpi (~> 2.1.0)
+      version (~> 1.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    httpi (2.1.0)
+      rack
+      rubyntlm (~> 0.3.2)
+    rack (1.5.2)
+    rubyntlm (0.3.4)
+    version (1.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  acoustid-api!

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Ryan Scott Lewis <ryan@rynet.us>
+
+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/Rakefile

@@ -0,0 +1,14 @@
+require 'pathname'
+require 'rake/version_task'
+require 'rubygems/package_task'
+
+gemspec = Pathname.glob( Pathname.new(__FILE__).join('..', '*.gemspec') ).first
+$spec = Gem::Specification.load( gemspec.to_s )
+
+Gem::PackageTask.new($spec) do |task|
+  task.need_zip = false
+end
+
+Rake::VersionTask.new do |task|
+  task.with_git_tag = true
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/acoustid-api.gemspec

@@ -0,0 +1,25 @@
+require 'pathname'
+
+Gem::Specification.new do |s|
+  
+  # Variables
+  s.author      = 'Ryan Scott Lewis'
+  s.email       = 'ryan@rynet.us'
+  s.summary     = 'A simple HTTP interface to the Acoustid.org API.'
+  s.license     = 'MIT'
+  
+  # Dependencies
+  s.add_dependency 'httpi',   '~> 2.1.0'
+  s.add_dependency 'version', '~> 1.0.0'
+  # s.add_development_dependency 'awesome_print', '~> 1.1.0'
+  
+  # Pragmatically set variables
+  s.homepage      = "http://github.com/RyanScottLewis/#{s.name}"
+  s.version       = Pathname.glob('VERSION*').first.read rescue '0.0.0'
+  s.description   = s.summary
+  s.name          = Pathname.new(__FILE__).basename('.gemspec').to_s
+  s.require_paths = ['lib']
+  s.files         = Dir['{{Rake,Gem}file{.lock,},README*,VERSION,LICENSE,*.gemspec,{lib,bin,examples,spec,test}/**/*}']
+  s.test_files    = Dir['{examples,spec,test}/**/*']
+  
+end

data/lib/acoustid/api.rb

@@ -0,0 +1,129 @@
+require 'version'
+require 'httpi'
+
+module Acoustid
+  
+  module API
+    
+    is_versioned
+    
+    class << self
+      
+      def lookup(options={})
+        options = parse_options(options)
+        
+        require 'acoustid/api/request/lookup'
+        
+        request = Request::Lookup.new( options[:params] )
+        
+        send( options[:method], request, options[:adapter] )
+      end
+      
+      def get(request, http_adapter=nil)
+        raise TypeError unless request.is_a?(Request::Base)
+        
+        http_request = HTTPI::Request.new( url: request.uri, query: request.params )
+        
+        HTTPI.get(http_request, http_adapter)
+      end
+      
+      def post(request, adapter=nil)
+        raise TypeError unless request.is_a?(Request::Base)
+        
+        http_request = HTTPI::Request.new( url: request.uri, body: request.params )
+        
+        HTTPI.post(http_request, adapter)
+      end
+      
+      protected
+      
+      def parse_options(options={})
+        raise TypeError, 'options must respond to :to_hash or :to_h' unless options.respond_to?(:to_hash) || options.respond_to?(:to_h)
+        options = options.to_hash rescue options.to_h
+        
+        options = { method: :post }.merge(options)
+        
+        raise TypeError, 'option :method must respond_to :to_sym' unless options[:method].respond_to?(:to_sym)
+        options[:method] = options[:method].to_s.strip.to_sym
+        raise TypeError, 'option :method must be either :get or :post' unless [:get, :post].include?( options[:method] )
+        
+        raise TypeError, 'option :params must respond to :to_hash or :to_h' unless options[:params].respond_to?(:to_hash) || options[:params].respond_to?(:to_h)
+        options[:params] = options[:params].to_hash rescue options[:params].to_h
+        
+        raise TypeError, 'option :adapter must respond_to :to_sym or be nil' unless options[:adapter].nil? || options[:adapter].respond_to?(:to_sym)
+        options[:adapter] = options[:adapter].to_s.strip.to_sym unless options[:adapter].nil?
+        
+        options
+      end
+      
+    end
+    
+  end
+  
+end
+
+# request = Acoustid::API.lookup(params: { client: 'omgomg' })
+
+__END__
+
+Lookup by fingerprint
+http://api.acoustid.org/v2/lookup
+
+Name  Required  Values  Description
+format  no  json, jsonp, xml  response format
+jsoncallback  no  jsonAcoustidApi  
+client  yes  8XaBELgH  application's API key
+duration  yes  641  duration of the whole audio file in seconds
+fingerprint  yes  AQABz0qUkZ...  audio fingerprint data
+meta  no  recordings, recordingids, releases, releaseids, releasegroups, releasegroupids, tracks, compress, usermeta, sources  returned metadata
+
+Lookup by track ID
+http://api.acoustid.org/v2/lookup
+
+Name  Required  Values  Description
+format  no  json, jsonp, xml  response format
+jsoncallback  no  jsonAcoustidApi  JSONP callback, only applicable if you select the jsonp format
+client  yes  8XaBELgH  application's API key
+trackid  yes  9ff43b6a-4f16-427c-93c2-92307ca505e0  track id (UUID)
+meta  no  recordings, recordingids, releases, releaseids, releasegroups, releasegroupids, tracks, compress, usermeta, sources  returned metadata
+
+Submit
+http://api.acoustid.org/v2/submit
+
+Name  Required  Values  Description
+format  no  json, xml  response format
+client  yes  8XaBELgH  application's API key
+clientversion  no  1.0  application's version
+wait  no  1  wait up to N seconds for the submission(s) to import
+user  yes  9Hg1oNwY  users's API key
+duration.#  yes  641  duration of the whole audio file in seconds
+fingerprint.#  yes  AQABz0qUkZ...  audio fingerprint data
+bitrate.#  no  192  bitrate of the audio file
+fileformat.#  no  MP3, M4A, ...  file format of the audio file
+mbid.#  no  4e0d8649-1f89-44f3-91af-4c0dbee81f28  corresponding MusicBrainz track ID
+track.#  no  High Hopes  track title
+artist.#  no  Pink Floyd  track artist
+album.#  no  The Division Bell  album title
+albumartist.#  no  Pink Floyd  album artist
+year.#  no  1994  album release year
+trackno.#  no  11  track number
+discno.#  no  1  disc number
+
+Get submission status (TODO: MIGHT HAVE TYPE IN URL!)
+http://api.acoustid.org/v2/submision_status
+
+Name  Required  Values  Description
+format  no  json, xml  response format
+client  yes  8XaBELgH  application's API key
+clientversion  no  1.0  application's version
+id  yes  123456789  submission ID, can be used multiple times
+
+
+List AcoustIDs by MBID
+http://api.acoustid.org/v2/track/list_by_mbid
+
+Name  Required  Values  Description
+format  no  json, jsonp, xml  response format
+jsoncallback  no  jsonAcoustidApi  JSONP callback, only applicable if you select the jsonp format
+mbid  yes  4e0d8649-1f89-44f3-91af-4c0dbee81f28  corresponding MusicBrainz recording ID (can be sent multiple times)
+batch  no  0, 1  use if you want to lookup multiple MBIDs

data/lib/acoustid/api/request/base.rb

@@ -0,0 +1,60 @@
+require 'uri'
+require 'acoustid/api/request/param_attributes'
+require 'acoustid/api/request/param_validations'
+
+module Acoustid
+  module API
+    module Request
+      
+      class Base
+        
+        extend ParamAttributes
+        extend ParamValidations
+        
+        class << self
+          
+          def base_uri
+            URI.parse('http://api.acoustid.org/v2/')
+          end
+          
+          def path(value=nil)
+            @path = value.to_s.strip unless value.nil?
+            
+            @path
+          end
+          
+        end
+        
+        attr_reader :params
+        
+        # Response format
+        param :format, validate: :validate_format, serialize: :serialize_string
+        
+        def initialize(params={})
+          raise TypeError, 'params must respond to :to_hash or :to_h' unless params.respond_to?(:to_hash) || params.respond_to?(:to_h)
+          params = params.to_hash rescue params.to_h
+          
+          params.each { |param, value| send("#{param}=", value) }
+        end
+        
+        def uri
+          uri = self.class.base_uri.dup
+          uri.path += self.class.path
+          
+          uri
+        end
+        
+        def valid?
+          self.class.required_params.none? do |required_param|
+            param = send(required_param)
+            
+            param.nil? || param.empty?# rescue true
+          end
+        end
+        
+        
+      end
+      
+    end
+  end
+end

data/lib/acoustid/api/request/lookup.rb

@@ -0,0 +1,47 @@
+require 'acoustid/api/request/base'
+
+module Acoustid
+  module API
+    module Request
+      
+      class Lookup < Base
+        
+        path 'lookup'
+        
+        # JSONP callback, only applicable if you select the jsonp format
+        param :json_callback, name: 'jsoncallback', serialize: :serialize_string
+        
+        # Application's API key
+        param :client, required: true, serialize: :serialize_string
+        
+        # Duration of the whole audio file in seconds
+        # Only required if trackid is not present
+        param :duration, validate: :validate_duration, serialize: :serialize_integer
+        
+        # Audio fingerprint data
+        # Only required if trackid is not present
+        param :fingerprint, serialize: :serialize_string
+        
+        # Track ID (UUID)
+        # Only required if duration and fingerprint are not present
+        param :track_id, name: 'trackid', serialize: :serialize_string
+        
+        # Returned metadata
+        param :meta, validate: :validate_meta, serialize: :serialize_meta
+        
+        # Different logic is needed for the validation of this API method
+        def valid?
+          invalid_duration = duration.nil?
+          invalid_fingerprint = fingerprint.nil? || fingerprint.empty?
+          invalid_track_id = track_id.nil? || track_id.empty?
+          
+          invalid_duration_and_fingerprint = invalid_duration && invalid_fingerprint
+          
+          super && (!invalid_duration_and_fingerprint && invalid_track_id || invalid_duration_and_fingerprint && !invalid_track_id)
+        end
+        
+      end
+      
+    end
+  end
+end

data/lib/acoustid/api/request/param_attributes.rb

@@ -0,0 +1,61 @@
+module Acoustid
+  module API
+    module Request
+      
+      module ParamAttributes
+        
+        def param_reader(param, options={})
+          raise TypeError, 'param must respond to :to_sym' unless param.respond_to?(:to_sym)
+          param = param.to_sym
+          
+          raise TypeError, 'options must respond to :to_hash or :to_h' unless options.respond_to?(:to_hash) || options.respond_to?(:to_h)
+          options = options.to_hash rescue options.to_h
+          
+          name = options[:name].to_s.strip
+          name = name.empty? ? param.to_s : name
+          
+          define_method(param) { (@params ||= {})[name] }
+        end
+        
+        def param_writer(param, options={})
+          raise TypeError, 'param must respond to :to_sym' unless param.respond_to?(:to_sym)
+          param = param.to_sym
+          
+          raise TypeError, 'options must respond to :to_hash or :to_h' unless options.respond_to?(:to_hash) || options.respond_to?(:to_h)
+          options = options.to_hash rescue options.to_h
+          
+          name = options[:name].to_s.strip
+          name = name.empty? ? param.to_s : name
+          
+          required_params << param if options[:required]
+          
+          raise TypeError, 'validate options must respond to :call or :to_sym' unless options[:validate].nil? || options[:validate].respond_to?(:call) || options[:validate].respond_to?(:to_sym)
+          validate = options[:validate]
+          validate = method(validate) if validate.respond_to?(:to_sym)
+          
+          raise TypeError, 'serialize options must respond to :call or :to_sym' unless options[:serialize].nil? || options[:serialize].respond_to?(:call) || options[:serialize].respond_to?(:to_sym)
+          serialize = options[:serialize]
+          serialize = method(serialize) if serialize.respond_to?(:to_sym)
+          
+          define_method("#{param}=") do |value|
+            validate.call(value) unless validate.nil?
+            value = serialize.call(value) unless serialize.nil?
+            
+            (@params ||= {})[name] = value
+          end
+        end
+        
+        def param(name, options={})
+          param_reader(name, options)
+          param_writer(name, options)
+        end
+        
+        def required_params
+          @required_params ||= []
+        end
+        
+      end
+      
+    end
+  end
+end

data/lib/acoustid/api/request/param_validations.rb

@@ -0,0 +1,40 @@
+module Acoustid
+  module API
+    module Request
+      
+      module ParamValidations
+        
+        VALID_META_VALUES = %W[recordings recordingids releases releaseids releasegroups releasegroupids tracks compress usermeta sources]
+        
+        def serialize_string(value)
+          value.nil? ? nil : value.to_s.strip
+        end
+        
+        def serialize_integer(value)
+          value.nil? ? nil : value.to_i
+        end
+        
+        def serialize_meta(value)
+          value.nil? ? nil : value.to_a.collect { |value| value.to_s.strip }
+        end
+        
+        def validate_format(value)
+          raise ArgumentError, '' unless %W[json jsonp xml].include?(value.to_s.strip)
+        end
+        
+        def validate_duration(value)
+          raise TypeError, 'duration must respond to :to_i' unless value.respond_to?(:to_i)
+        end
+        
+        def validate_meta(value)
+          raise TypeError, 'meta must respond to :to_a or be nil' unless value.nil? || value.respond_to?(:to_a)
+          raise TypeError, "meta must only include #{ VALID_META_VALUES.join(', ') }" unless value.nil? || serialize_meta(value).all? { |meta| VALID_META_VALUES.include?(meta) }
+          
+          # TODO
+        end
+        
+      end
+      
+    end
+  end
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: acoustid-api
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ryan Scott Lewis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httpi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: version
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+description: A simple HTTP interface to the Acoustid.org API.
+email: ryan@rynet.us
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- Rakefile
+- VERSION
+- acoustid-api.gemspec
+- lib/acoustid/api.rb
+- lib/acoustid/api/request/base.rb
+- lib/acoustid/api/request/lookup.rb
+- lib/acoustid/api/request/param_attributes.rb
+- lib/acoustid/api/request/param_validations.rb
+- lib/acoustid/api/request/submit.rb
+- lib/acoustid/api/response.rb
+homepage: http://github.com/RyanScottLewis/
+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: A simple HTTP interface to the Acoustid.org API.
+test_files: []