notu 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e624e1e0724b52253ee45953acadf9f0614dcbb3
+  data.tar.gz: 7540301e160396bf7630cb8398ea29f5a7959917
+SHA512:
+  metadata.gz: ac2cef63ae77bd529389076774f156855ede52dd5d2bdd4e85ffd7a8bfce1a7b6ec0319b14cc3f18cbde4a7f346fe43b1682813bcefeacf4ce3a4e3767544051
+  data.tar.gz: 2d272e01ccfcecfafabc99b09c17155b1861346cc60004ed028ee3efdc8734f109050c16def7540d9ff8be07c61968f0a23dfbe88befe5e441cbe731e9aa00a8

data/.gitignore

@@ -0,0 +1,5 @@
+.DS_Store
+.bundle
+.ruby-version
+Gemfile.lock
+pkg/*

data/.rspec

@@ -0,0 +1,2 @@
+--colour
+--order random

data/Gemfile

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

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Alexis Toulotte
+
+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,10 @@
+require 'bundler'
+require 'rspec/core/rake_task'
+
+Bundler::GemHelper.install_tasks
+
+desc 'Default: runs specs.'
+task default: :spec
+
+desc 'Run all specs in spec directory.'
+RSpec::Core::RakeTask.new(:spec)

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/notu.rb

@@ -0,0 +1,18 @@
+require 'active_support/core_ext'
+require 'byebug' if ENV['DEBUGGER']
+require 'cgi'
+require 'net/https'
+require 'nokogiri'
+
+lib_path = "#{__dir__}/notu"
+
+require "#{lib_path}/error"
+require "#{lib_path}/network_error"
+require "#{lib_path}/parse_error"
+
+require "#{lib_path}/html_document"
+require "#{lib_path}/http_download"
+require "#{lib_path}/library"
+require "#{lib_path}/loved_tracks"
+require "#{lib_path}/most_played_tracks"
+require "#{lib_path}/track"

data/lib/notu/error.rb

@@ -0,0 +1,15 @@
+module Notu
+
+  class Error < StandardError
+
+    attr_reader :original
+
+    def initialize(message)
+      @original = message.is_a?(Exception) ? message : nil
+      message = original.message if original.is_a?(Exception)
+      super(message.to_s.squish.presence)
+    end
+
+  end
+
+end

data/lib/notu/html_document.rb

@@ -0,0 +1,20 @@
+module Notu
+
+  module HtmlDocument
+
+    def self.get(url, options = {})
+      parse(HttpDownload.get(url, options))
+    end
+
+    private
+
+    def self.parse(data)
+      data = data.gsub(/ /i, ' ').gsub(/\s+/, ' ')
+      document = Nokogiri::HTML.parse(data, nil, 'UTF-8')
+      raise ParseError.new('Invalid HTML document') if (document/'head').empty?
+      document
+    end
+
+  end
+
+end

data/lib/notu/http_download.rb

@@ -0,0 +1,39 @@
+module Notu
+
+  module HttpDownload
+
+    def self.get(url, options = {})
+      uri = url.is_a?(URI) ? url : URI.parse(url)
+      raise "Invalid URL: #{url.inspect}" unless uri.is_a?(URI::HTTP)
+      options.reverse_merge!(max_redirects: 10, timeout: 10, max_retries: 3, retry_sleep: 2)
+      connection = Net::HTTP.new(uri.host, uri.port)
+      connection.open_timeout = options[:timeout]
+      connection.read_timeout = options[:timeout]
+      if uri.is_a?(URI::HTTPS)
+        connection.use_ssl = true
+        connection.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      end
+      connection.start do |http|
+        http.request_get(uri.request_uri, (options[:headers] || {}).stringify_keys) do |response|
+          begin
+            response.value # raise if not success
+          rescue Net::HTTPRetriableError
+            raise 'Max redirects has been reached' if options[:max_redirects] < 1
+            options[:max_redirects] -= 1
+            return get(response['Location'], options)
+          end
+          return response.body
+        end
+      end
+    rescue Net::ReadTimeout, TimeoutError, Timeout::Error, Zlib::BufError => exception
+      raise NetworkError.new(exception) if options[:max_retries] < 1
+      options[:max_retries] -= 1
+      sleep(options[:retry_sleep])
+      get(url, options)
+    rescue => exception
+      raise NetworkError.new(exception)
+    end
+
+  end
+
+end

data/lib/notu/library.rb

@@ -0,0 +1,52 @@
+module Notu
+
+  class Library
+
+    DEFAULT_HOST = 'www.last.fm'
+
+    attr_reader :host, :username
+
+    def initialize(options = {})
+      options = options.stringify_keys
+      self.host = options['host']
+      self.username = options['username']
+    end
+
+    def loved_tracks
+      LovedTracks.new(self)
+    end
+
+    def most_played_tracks(options = {})
+      MostPlayedTracks.new(self, options)
+    end
+
+    def url(options = {})
+      options = options.stringify_keys
+      path = options['path'].presence
+      query = options['query'].presence
+      query = options['query'].map { |name, value| "#{CGI.escape(name.to_s)}=#{CGI.escape(value.to_s)}" }.join('&') if options['query'].is_a?(Hash)
+      "http://#{host}/user/#{username}".tap do |url|
+        if path.present?
+          url << '/' unless path.starts_with?('/')
+          url << path
+        end
+        if query.present?
+          url << '?' << query
+        end
+      end
+    end
+
+    private
+
+    def host=(value)
+      @host = value.presence || DEFAULT_HOST
+    end
+
+    def username=(value)
+      @username = value.to_s.strip.downcase
+      raise Error.new("Invalid Last.fm username: #{value.inspect}") if username !~ /^[a-z0-9_]+$/
+    end
+
+  end
+
+end

data/lib/notu/loved_tracks.rb

@@ -0,0 +1,40 @@
+module Notu
+
+  class LovedTracks
+
+    include Enumerable
+
+    attr_reader :library
+
+    def initialize(library)
+      raise ArgumentError.new("#{self.class}#library must be a library, #{library.inspect} given") unless library.is_a?(Library)
+      @library = library
+    end
+
+    def each(&block)
+      return unless block_given?
+      page_urls.each do |url|
+        document = HtmlDocument.get(url)
+        (document/'#lovedTracks td.subjectCell').each do |element|
+          yield(Track.new(artist: (element/'a').first.text, title: (element/'a').last.text))
+        end
+      end
+      nil
+    end
+
+    private
+
+    def page_urls
+      @loved_pages ||= (1..pages_count).map do |index|
+        library.url(path: 'library/loved', query: { 'sortBy' => 'date', 'sortOrder' => 'desc', 'page' => index })
+      end
+    end
+
+    def pages_count
+      document = HtmlDocument.get(library.url(path: 'library/loved'))
+      [1, (document/'div.whittle-pagination a').map { |link| link.text.to_i }].flatten.max
+    end
+
+  end
+
+end

data/lib/notu/most_played_tracks.rb

@@ -0,0 +1,46 @@
+module Notu
+
+  class MostPlayedTracks
+
+    include Enumerable
+
+    PERIODS = {
+      'last_week' => 'week',
+      'last_month' => '1month',
+      'last_3_months' => '3month',
+      'last_6_months' => '6month',
+      'last_year' => 'year',
+      'overall' => 'overall',
+    }
+
+    attr_reader :library, :period
+
+    def initialize(library, options = {})
+      raise ArgumentError.new("#{self.class}#library must be a library, #{library.inspect} given") unless library.is_a?(Library)
+      @library = library
+      options = options.stringify_keys.reverse_merge('period' => PERIODS.keys.first)
+      self.period = options['period']
+    end
+
+    def each(&block)
+      return unless block_given?
+      document = HtmlDocument.get(library.url(path: 'charts', query: { 'rangetype' => PERIODS[period], 'subtype' => 'tracks' }))
+      (document/'table.chart tbody tr').each do |element|
+        artist = (element/'td.subjectCell a').first.text
+        plays_count = (element/'td.chartbarCell a span').text.strip
+        title = (element/'td.subjectCell a').last.text
+        yield(Track.new(artist: artist, plays_count: plays_count, title: title))
+      end
+      nil
+    end
+
+    private
+
+    def period=(value)
+      raise ArgumentError.new("Notu::MostPlayedTracks#period is invalid: #{value.inspect}") unless PERIODS.key?(value.to_s)
+      @period = value.to_s
+    end
+
+  end
+
+end

data/lib/notu/network_error.rb

@@ -0,0 +1,6 @@
+module Notu
+
+  class NetworkError < Error
+  end
+
+end

data/lib/notu/parse_error.rb

@@ -0,0 +1,6 @@
+module Notu
+
+  class ParseError < Error
+  end
+
+end

data/lib/notu/track.rb

@@ -0,0 +1,30 @@
+module Notu
+
+  class Track
+
+    attr_reader :artist, :plays_count, :title
+
+    def initialize(attributes = {})
+      attributes = attributes.stringify_keys
+      self.artist = attributes['artist']
+      self.plays_count = attributes['plays_count']
+      self.title = attributes['title']
+    end
+
+    private
+
+    def artist=(value)
+      @artist = value.to_s.squish.presence || raise(Error.new("#{self.class}#artist must be specified, #{value.inspect} given"))
+    end
+
+    def plays_count=(value)
+      @plays_count = value.is_a?(Integer) || value.is_a?(String) && value =~ /\A[0-9]+\z/ ? [0, value.to_i].max : nil
+    end
+
+    def title=(value)
+      @title = value.to_s.squish.presence || raise(Error.new("#{self.class}#title must be specified, #{value.inspect} given"))
+    end
+
+  end
+
+end

data/notu.gemspec

@@ -0,0 +1,27 @@
+Gem::Specification.new do |s|
+  s.name = 'notu'
+  s.version = File.read("#{File.dirname(__FILE__)}/VERSION").strip
+  s.platform = Gem::Platform::RUBY
+  s.author = 'Alexis Toulotte'
+  s.email = 'al@alweb.org'
+  s.homepage = 'https://github.com/alexistoulotte/notu'
+  s.summary = 'API for Last.fm'
+  s.description = 'API to get Last.fm most played and loved tracks'
+  s.license = 'MIT'
+
+  s.rubyforge_project = 'notu'
+
+  s.files = `git ls-files`.split("\n")
+  s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ['lib']
+
+  s.add_dependency 'activesupport', '>= 4.1.0', '< 4.2.0'
+  s.add_dependency 'nokogiri', '>= 1.6.0', '< 1.7.0'
+
+  s.add_development_dependency 'byebug', '>= 3.2.0', '< 3.3.0'
+  s.add_development_dependency 'rake', '>= 10.3.0', '< 10.4.0'
+  s.add_development_dependency 'rspec', '>= 3.0.0', '< 3.1.0'
+  s.add_development_dependency 'vcr', '>= 2.9.0', '< 2.10.0'
+  s.add_development_dependency 'webmock', '>= 1.18.0', '< 1.19.0'
+end

data/spec/cassettes/Notu_HtmlDocument/_get/follows_redirects.yml

@@ -0,0 +1,178 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://www.alweb.org/
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 301
+      message: Moved Permanently
+    headers:
+      Date:
+      - Thu, 28 Aug 2014 22:42:20 GMT
+      Server:
+      - Apache/2.2.16 (Debian)
+      Location:
+      - http://alweb.org/
+      Vary:
+      - Accept-Encoding
+      Content-Length:
+      - '241'
+      Content-Type:
+      - text/html; charset=iso-8859-1
+    body:
+      encoding: UTF-8
+      string: |
+        <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
+        <html><head>
+        <title>301 Moved Permanently</title>
+        </head><body>
+        <h1>Moved Permanently</h1>
+        <p>The document has moved <a href="http://alweb.org/">here</a>.</p>
+        <hr>
+        <address>Apache/2.2.16 (Debian) Server at www.alweb.org Port 80</address>
+        </body></html>
+    http_version: 
+  recorded_at: Thu, 28 Aug 2014 22:42:21 GMT
+- request:
+    method: get
+    uri: http://alweb.org/
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Thu, 28 Aug 2014 22:42:21 GMT
+      Server:
+      - Apache/2.2.16 (Debian)
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Xss-Protection:
+      - 1; mode=block
+      X-Content-Type-Options:
+      - nosniff
+      Etag:
+      - '"f24a7f595f7d88d135193e6f203bfbd5"'
+      Cache-Control:
+      - public
+      X-Request-Id:
+      - 005d51c9-30e8-45bc-886a-476b46509307
+      X-Runtime:
+      - '0.005857'
+      X-Powered-By:
+      - Phusion Passenger 4.0.49
+      Status:
+      - 200 OK
+      Vary:
+      - Accept-Encoding
+      Content-Length:
+      - '929'
+      Content-Type:
+      - text/html; charset=utf-8
+    body:
+      encoding: UTF-8
+      string: |
+        <!DOCTYPE html>
+
+        <html lang="fr">
+
+        <head>
+          <meta charset="utf-8" />
+          <title>Alexis Toulotte</title>
+          <meta name="author" content="Alexis Toulotte" />
+          <meta name="description" content="Page personnelle d'Alexis Toulotte." />
+          <meta name="robots" content="all" />
+          <link rel="schema.DC" href="http://purl.org/dc/elements/1.1/" />
+          <meta name="DC.format" content="text/html" />
+          <meta name="DC.language" content="fr" />
+          <meta name="DC.title" content="Alexis Toulotte" />
+          <meta name="DC.creator" content="Alexis Toulotte" />
+          <meta name="DC.description" content="Page personnelle d'Alexis Toulotte." />
+          <meta name="google-site-verification" content="1dodRvC0Zp-iAZilnTeT5PaY4bPKHwSzs9994-3g304" />
+          <script src="/assets/application-2faf062622c53593fc90ee0ba5667a48.js"></script>
+          <link href="/assets/application-a374b3c70bad2d98bffceac38d81f6d5.css" media="screen" rel="stylesheet" />
+          <link href="/avatar?size=128" rel="icon" type="image/png" />
+          <link rel="stylesheet" href="//fonts.googleapis.com/css?family=Dancing Script" />
+          <link rel="stylesheet" href="//fonts.googleapis.com/css?family=Raleway" />
+        </head>
+
+        <body>
+
+          <h1>Alexis Toulotte</h1>
+
+        <ul class="services">
+          <li class="github">
+            <a href="https://github.com/alexistoulotte"><span>GitHub</span></a>
+          </li>
+          <li class="rubygems">
+            <a href="https://rubygems.org/profiles/alexistoulotte"><span>RubyGems</span></a>
+          </li>
+          <li class="cv">
+            <a href="https://dl.dropbox.com/u/5601946/CV.pdf"><span>CV</span></a>
+          </li>
+          <li class="email">
+            <a href="#"><span>Email</span></a>
+          </li>
+          <li class="phone">
+            <a href="callto://+687817612"><span>+687 81 76 12</span></a>
+          </li>
+          <li class="skype">
+            <a href="skype:alexistoulotte"><span>Skype</span></a>
+          </li>
+          <li class="twitter">
+            <a href="https://twitter.com/alexistoulotte"><span>Twitter</span></a>
+          </li>
+          <li class="facebook">
+            <a href="https://www.facebook.com/alexis.toulotte"><span>Facebook</span></a>
+          </li>
+          <li class="linked-in">
+            <a href="https://www.linkedin.com/in/alexistoulotte"><span>LinkedIn</span></a>
+          </li>
+          <li class="google-plus">
+            <a href="https://plus.google.com/111956742901852825014/posts"><span>Google+</span></a>
+          </li>
+          <li class="youtube">
+            <a href="https://www.youtube.com/alexistoulotte"><span>YouTube</span></a>
+          </li>
+          <li class="mixcloud">
+            <a href="https://www.mixcloud.com/alexistoulotte"><span>Mixcloud</span></a>
+          </li>
+          <li class="last-fm">
+            <a href="http://www.lastfm.fr/user/alexistoulotte"><span>Last.fm</span></a>
+          </li>
+          <li class="sound-cloud">
+            <a href="https://soundcloud.com/alexistoulotte"><span>SoundCloud</span></a>
+          </li>
+          <li class="delicious">
+            <a href="https://delicious.com/alexistoulotte"><span>Delicious</span></a>
+          </li>
+        </ul>
+
+
+        </body>
+
+        </html>
+    http_version: 
+  recorded_at: Thu, 28 Aug 2014 22:42:21 GMT
+recorded_with: VCR 2.9.2