ongaku_ryoho_server 0.1.0

data/.gitignore

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

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 TODO: Write your name
+
+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,34 @@
+# Ongaku Ryoho Server
+
+A little Sinatra web server wrapped in a gem specifically for the [Ongaku Ryoho client](https://github.com/icidasset/ongaku_ryoho).
+
+## How to use
+
+### Requirements
+
+`Ruby 1.9.2`
+
+### Installation
+
+```bash
+gem install ongaku_ryoho_server
+```
+
+### Usage
+
+Go to a music directory and run the web server.
+
+```bash
+cd ~/Music
+(rvmsudo) ongaku_ryoho_server (-p 80)
+```
+
+### Options
+
+Some Sinatra options, that is.
+
+```
+-p port    set the port (default is 4567)
+-o addr    set the host (default is 0.0.0.0)
+-x         turn on the mutex lock (default is off)
+```

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/bin/ongaku_ryoho_server

@@ -0,0 +1,22 @@
+#!/usr/bin/env ruby
+require_relative '../lib/ongaku_ryoho_server.rb'
+
+#
+# Look for some of the Sinatra options and pass them along
+
+options = {}
+
+if ARGV.any?
+  require 'optparse'
+  OptionParser.new { |op|
+    op.on('-p port',   'set the port (default is 4567)')            { |val| options[:port] = Integer(val) }
+    op.on('-o addr',   'set the host (default is 0.0.0.0)')         { |val| options[:bind] = val }
+    op.on('-x',        'turn on the mutex lock (default is off)')   {       options[:lock] = true }
+  }.parse!(ARGV.dup)
+end
+
+
+#
+# Run the server
+
+OngakuRyohoServer.run(options)

data/lib/ongaku_ryoho_server/application.rb

@@ -0,0 +1,164 @@
+require 'json'
+require 'mp3info'
+require 'sinatra'
+require 'puma'
+require 'uri'
+
+module OngakuRyohoServer
+  #
+  # { Application }
+  #
+  # === Info
+  #
+  # Sinatra application which basicly takes care of everything
+  # More info inside
+
+  class Application < Sinatra::Base
+    set :environment, :production
+    set :server, :puma
+
+
+    # root
+    get '/' do
+      content_type :json
+      process_this_directory.to_json
+    end
+
+
+    # availability
+    get '/available?' do
+      "As it happens, I am."
+    end
+
+
+    # compare filelists
+    post '/check' do
+      content_type :json
+      check_files(params[:file_list]).to_json
+    end
+
+
+    # music file
+    get %r{.(mp3)$}i do
+      requested_item = URI.unescape(request.path_info[1..-1])
+      File.exists?(requested_item) ? send_file(requested_item) : 404
+    end
+
+
+    # everything else
+    get %r{.+} do
+      403
+    end
+
+
+    #
+    # Read directory
+    #
+    # => find music in the current directory
+    #
+    # [output]
+    #   file list
+    #
+    def read_directory
+      Dir.glob('**/*.{mp3}')
+    end
+
+
+    #
+    # Check files
+    #
+    # => compares a given file list to the file list from the current directory
+    #    show which files are missing and scan the ones that are new
+    #
+    # [params]
+    #   file_list_from_client
+    #
+    # [output]
+    #   object containing missing_files and new_tracks array
+    #
+    def check_files(file_list_from_client)
+      file_list_from_client = JSON.parse(file_list_from_client)
+      file_list_from_server = read_directory
+
+      missing_files = file_list_from_client - file_list_from_server
+      new_files = file_list_from_server - file_list_from_client
+
+      new_tracks = process_music(new_files, { last_modified: Time.now })
+
+      return {
+        missing_files: missing_files,
+        new_tracks: new_tracks
+      }
+    end
+
+
+    #
+    # Process this directory
+    #
+    # => read directory and process its contents
+    #
+    # [output]
+    #   processed contents (see method below)
+    #
+    def process_this_directory
+      music_collection = read_directory
+      return process_music(music_collection)
+    end
+
+
+    #
+    # Process music
+    #
+    # => open each music track, get its tags and return all of them
+    #
+    # [params]
+    #   music_collection : array of files to process (i.e. filepaths)
+    #   extra_properties : properties to include in each track object/hash
+    #
+    # [output]
+    #   tracks : collection of all the tracks their tags
+    #
+    def process_music(music_collection, extra_properties = {})
+      tracks = []
+      
+      # loop over every track
+      music_collection.each do |location|
+        rpartition = location.rpartition('/')
+        filename   = rpartition[2]
+        
+        track = {}
+        
+        case File.extname(filename)
+        when '.mp3'
+          Mp3Info.open(location) do |mp3|
+            tags = {
+              title:    mp3.tag.title,
+              artist:   mp3.tag.artist,
+              album:    mp3.tag.album,
+              year:     mp3.tag.year,
+              tracknr:  mp3.tag.tracknum,
+              genres:   mp3.tag.genre_s
+            }
+            
+            tags.each do |key, value|
+              tags[key] = 'Unknown' if value.nil? or (value.respond_to?(:empty) and value.empty?)
+            end
+            
+            tags.merge!({ filename: filename, location: location })
+            
+            track = tags.clone
+          end
+        end
+        
+        unless track.empty?
+          track.merge!(extra_properties)
+          tracks << track
+        end
+      end
+      
+      # return all tracks
+      return tracks
+    end
+
+  end
+end

data/lib/ongaku_ryoho_server/version.rb

@@ -0,0 +1,6 @@
+module OngakuRyohoServer
+  #
+  # { VERSION }
+
+  VERSION = "0.1.0"
+end

data/lib/ongaku_ryoho_server.rb

@@ -0,0 +1,11 @@
+require_relative "ongaku_ryoho_server/version"
+require_relative "ongaku_ryoho_server/application"
+
+module OngakuRyohoServer
+  #
+  # { Class methods }
+
+  def self.run(options)
+    OngakuRyohoServer::Application.run!(options)
+  end
+end

data/ongaku_ryoho_server.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/ongaku_ryoho_server/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Steven Vandevelde"]
+  gem.email         = ["icid.asset@gmail.com"]
+  gem.description   = %q{Serves music to Ongaku Ryoho clients}
+  gem.summary       = %q{Serves music to Ongaku Ryoho clients}
+  gem.homepage      = "https://github.com/icidasset/ongaku_ryoho_server"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "ongaku_ryoho_server"
+  gem.require_paths = ["lib"]
+  gem.version       = OngakuRyohoServer::VERSION
+
+  gem.add_dependency 'json', '~> 1.6.6'
+  gem.add_dependency 'ruby-mp3info', '~> 0.7.1'
+  gem.add_dependency 'sinatra', '~> 1.3.2'
+  gem.add_dependency 'puma'
+
+  gem.add_development_dependency 'rake'
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: ongaku_ryoho_server
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Steven Vandevelde
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-10 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: &70299057328240 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.6
+  type: :runtime
+  prerelease: false
+  version_requirements: *70299057328240
+- !ruby/object:Gem::Dependency
+  name: ruby-mp3info
+  requirement: &70299057327740 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.1
+  type: :runtime
+  prerelease: false
+  version_requirements: *70299057327740
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: &70299057327280 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.2
+  type: :runtime
+  prerelease: false
+  version_requirements: *70299057327280
+- !ruby/object:Gem::Dependency
+  name: puma
+  requirement: &70299057326900 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70299057326900
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70299057326440 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70299057326440
+description: Serves music to Ongaku Ryoho clients
+email:
+- icid.asset@gmail.com
+executables:
+- ongaku_ryoho_server
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/ongaku_ryoho_server
+- lib/ongaku_ryoho_server.rb
+- lib/ongaku_ryoho_server/application.rb
+- lib/ongaku_ryoho_server/version.rb
+- ongaku_ryoho_server.gemspec
+homepage: https://github.com/icidasset/ongaku_ryoho_server
+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: 
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: Serves music to Ongaku Ryoho clients
+test_files: []