scrobbler-ng-utils 2.0.2

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Uwe L. Korn
+
+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.rdoc

@@ -0,0 +1,17 @@
+= scrobbler-ng-utils
+
+Description goes here.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Uwe L. Korn. See LICENSE for details.

data/lib/scrobbler-ng-utils/cache/mongo.rb

@@ -0,0 +1,94 @@
+# encoding: utf-8
+
+require 'mongo'
+
+module Scrobbler
+  module Cache
+    # Caching Module which stores everything in a MongoDB Collection
+    #
+    # @author Uwe L. Korn
+    class Mongo
+      
+      # Create a new Instance for caching Last.fmn requests.
+      #
+      # @param [Mongo:Collecion] collection The MongoDB collection for storage
+      def initialize(collection)
+        @hits = 0
+        @misses = 0
+        @collection = collection
+        @write = true
+      end
+    
+      # Could we write to this cache?
+      #
+      # @return [boolean]
+      def writable?
+        @write
+      end
+      
+      # Is there already an entry for these query?
+      #
+      # @param [Hash] params The parameters for the Last.fm Request
+      # @return [boolean]
+      def has?(params={})
+        # Check if there is a matching chache entry with no extra parameters
+        @collection.find(params).each do |doc|
+          if verify(doc, params) then
+            @hits += 1
+            return true
+          end
+        end
+        
+        # We have not found a mathing cache entry.
+        @misses += 1
+        false
+      end
+      
+      # Store a result into the database.
+      #
+      # @param [String] data
+      # @param [Hash] params
+      # @return [void]
+      def set(data, params={})
+        if not has?(params) then
+         @collection.insert(params.merge({:xml => data, :timestamp => Time.now.to_i}))
+        end
+      end
+      
+      # Get a cached result
+      #
+      # @param [Hash] params
+      # @return [String]
+      def get(params={})
+        @collection.find(params).each do |doc|
+          return doc['xml'] if verify(doc)
+        end
+      end
+      
+      # Verify that a specific document matches exactly the request cache.
+      #
+      # @param [Hash] params
+      # @param [Hash] doc
+      # @return [boolean]
+      def verify(doc, params={}) 
+        matches = true
+        doc.each do |k,v|
+          next if ['xml', 'timestamp', '_id'].include?(k)
+          matches &&= (not (params[k].nil? && params[k.to_sym].nil?))
+        end
+        matches
+      end
+      
+      # Print statistics how efficent this cache was
+      #
+      # @param [String] prefix The prefix which will be printed before each line
+      # @return [void]
+      def print_stats(prefix="")
+        puts prefix + "Hits: #{@hits}"
+        puts prefix + "Misses: #{@misses}"
+        hitrate = @hits * 1.0 / (@misses + @hits)
+        puts prefix + "Hit-Rate: #{hitrate}"
+      end
+    end
+  end
+end

data/spec/scrobbler-ng-utils_spec.rb

@@ -0,0 +1,7 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "ScrobblerNgUtils" do
+  it "fails" do
+    fail "hey buddy, you should probably rename this file and start specing for real"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'scrobbler-ng-utils'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification 
+name: scrobbler-ng-utils
+version: !ruby/object:Gem::Version 
+  hash: 11
+  prerelease: false
+  segments: 
+  - 2
+  - 0
+  - 2
+  version: 2.0.2
+platform: ruby
+authors: 
+- Uwe L. Korn
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-08-05 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: yard
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+description: Utilities like caching, rate limiting, ... for usage in combination with the scrobbler gem. These will be not included in the main gem as they provide extra functionality that is not always required.
+email: uwelk@xhochy.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- lib/scrobbler-ng-utils.rb
+- lib/scrobbler-ng-utils/cache/mongo.rb
+- LICENSE
+- README.rdoc
+- spec/spec_helper.rb
+- spec/scrobbler-ng-utils_spec.rb
+has_rdoc: true
+homepage: http://github.com/xhochy/scrobbler-ng-utils
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Utilities for usage in combination with the scrobbler-ng gem
+test_files: 
+- spec/spec_helper.rb
+- spec/scrobbler-ng-utils_spec.rb