phishin-client 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d6ba6717562dcaf7dd994c1af15a4c1af646465c
-  data.tar.gz: 767ed8669cc0948e001a693515aba36937922ef1
+  metadata.gz: c31df8b669a3fc0b684d189fda45bc2525da697c
+  data.tar.gz: 2e73e1e28a5f23c4fccbc1b623a2f1adbe539b89
 SHA512:
-  metadata.gz: 7a43194c60950bd245ed48232c19a4e476a9f0ae662c42ff6b131748a4e4bf11bf4d9c61f9441c9e259f02430b39a15f4187e8fda63e9dd9a6fb1a247f95196f
-  data.tar.gz: 3e0a13c14bcf6db790b9ba00a3682a086902d4fec36abf699f30f280a1342adb915844cb28d492318708b5aa5644e9d4dc9ba07ecfde0a60f27fbdc6286e1607
+  metadata.gz: 9a46ee9486dd17392f9ed597351be9dcc2537a11cf7b36d90d8de3513863632a110d683ff7a9cadad37c4415f446d4e885aa2f44afb022220685987fd07a1ec3
+  data.tar.gz: a837f573985ab56a7c6b2b09aa2787d0c87310f6d955cd19b6361d2e8ee0c44bbaf1c55270fce24f189e968350301b9ea6b9d7918695ba1e3bee451710f67b7e

data/README.md

@@ -16,10 +16,14 @@ Talks to the http://phish.in API. Has built-in caching.
 ```ruby
 require 'phishin-client'
 doglogger = Logger.new
-c = Phishin::Client.new log: true, logger: doglogger
+c = Phishin::Client.new log: true, logger: doglogger, cache_options: { memcached_servers: ['localhost:11211'] }
+# to not use caching, don't specify the :cache => false option
 
-response = c.get_tracks(page: 1, per_page: 40)  # Phishin::Api::Response instance
+response = c.tracks(params: { page: 1, per_page: 40 })  # Phishin::Api::Response instance
 json_hash = response.data
+
+# no caching for this request
+response = c.tracks(params: { page: 1, per_page: 40 }, force: true)  # Phishin::Api::Response instance
 ```
 
 ## License

data/lib/phishin/api/response.rb

@@ -17,16 +17,13 @@ module Phishin
           @total_pages = response_data['total_pages']
           @page = response_data['page']
           @data = response_data['data']
+          @data = @data.is_a?(Hash) ? Hashie::Mash.new(@data) : @data.map{ |d| d.is_a?(Hash) ? Hashie::Mash.new(d) : d }
         else
           @message = response_data['message']
           raise Phishin::Client::UnsuccessfulResponseError.new(url, @message)
         end
       end
 
-      def [](key)
-        return @data[key]
-      end
-
       def success?
         return @success == true
       end

data/lib/phishin/api/v1.rb

@@ -3,97 +3,136 @@ module Phishin
     module V1
       BASE_URL = 'http://phish.in/api/v1'
       HEADERS = { 'accept' => 'application/json' }
-      DEFAULT_PARAMS = %i[page per_page sort_attr sort_dir]
 
-      # @param id_or_slug [String,Integer] track id or slug
-      def get_track(id_or_slug)
-        check_id_arg('track', id_or_slug)
-        perform_get_request('tracks/%s.json' % id_or_slug.to_s)
-      end
-
-      # @option opts [Integer] :page The desired page
-      # @option opts [Integer] :per_page Results per page
-      def get_tracks(opts={})
-        perform_get_request('tracks.json', select_params(opts, DEFAULT_PARAMS))
-      end
-
-
-
-      # @param (see #get_track)
-      def get_show(id_or_slug)
+      # Get track by id.
+      #
+      # @param id [Integer] id belonging to the the resource
+      # @option opts [Boolean] :force (false) no caching for this request
+      def track(id, opts={})
+        check_id_arg('track', id)
+        perform_get_request(format('tracks/%d.json', id), nil, opts)
+      end
+
+      # Get many tracks.
+      #
+      # For more on available params, see http://phish.in/api-docs.
+      #
+      # @option opts (see #track)
+      # @option opts [Hash] :params parameters for HTTP GET query string
+      #   - :page (Integer) The desired page
+      #   - :per_page (Integer) Results per page
+      #   - :sort_attr (String) Sorting attribute
+      #   - :sort_dir  (String) Sorting direction (ASC|DESC)
+      def tracks(opts={})
+        perform_get_request('tracks.json', opts)
+      end
+
+
+      # Get show by id or slug (ie, date).
+      #
+      # @param id_or_slug [Integer] id or slug belonging to the the resource
+      # @option opts (see #track)
+      def show(id_or_slug, opts={})
         check_id_arg('show', id_or_slug)
-        perform_get_request('shows/%s.json' % id_or_slug.to_s)
+        perform_get_request(format('shows/%s.json', id_or_slug.to_s), opts)
       end
 
-      # @option (see #get_tracks)
-      def get_shows(opts={})
-        perform_get_request('shows.json', select_params(opts, DEFAULT_PARAMS))
+      # Get many shows.
+      #
+      # @option opts (see #tracks)
+      def shows(opts={})
+        perform_get_request('shows.json', opts)
       end
 
+      # Get show by date (YYYY-MM-DD).
+      #
       # @param show_date [String] a show date in the format YYYY-MM-DD
-      def get_show_on_date(show_date)
+      # @option opts (see #track)
+      # @raise [Phishin::Cilent::Error] if the date format is wrong
+      def show_on_date(show_date, opts={})
         raise Phishin::Client::Error, "invalid argument: show_date must match YYYY-MM-DD" unless show_date && show_date =~ /\d{4}-\d{2}-\d{2}/
-        perform_get_request('show-on-date/%s.json' % show_date)
+        perform_get_request(format('show-on-date/%s.json', show_date), opts)
       end
 
 
 
-      # @param (see #get_track)
-      def get_song(id_or_slug)
+      # Get song by id or slug.
+      #
+      # @param id_or_slug (see #show)
+      # @option opts (see #track)
+      def song(id_or_slug, opts={})
         check_id_arg('song', id_or_slug)
-        perform_get_request('songs/%s.json' % id_or_slug.to_s)
+        perform_get_request(format('songs/%s.json', id_or_slug.to_s), opts)
       end
 
-      # @option (see #get_tracks)
-      def get_songs(opts={})
-        perform_get_request('songs.json', select_params(opts, DEFAULT_PARAMS))
+      # Get many songs
+      #
+      # @option opts (see #tracks)
+      def songs(opts={})
+        perform_get_request('songs.json', opts)
       end
 
 
 
-      # @param (see #get_track)
-      def get_tour(id_or_slug)
+      # Get tour by id or slug.
+      #
+      # @param id_or_slug (see #show)
+      # @option opts (see #track)
+      def tour(id_or_slug, opts={})
         check_id_arg('tour', id_or_slug)
-        perform_get_request('tours/%s.json' % id_or_slug.to_s)
+        perform_get_request(format('tours/%s.json', id_or_slug.to_s), opts)
       end
 
-      # @option (see #get_tracks)
-      def get_tours(opts={})
-        perform_get_request('tours.json', select_params(opts, DEFAULT_PARAMS))
+      # Get many tours.
+      #
+      # @option opts (see #tracks)
+      def tours(opts={})
+        perform_get_request('tours.json', opts)
       end
 
 
 
-      # @param (see #get_track)
-      def get_venue(id_or_slug)
+      # Get venue by id or slug.
+      #
+      # @param id_or_slug (see #show)
+      # @option opts (see #track)
+      def venue(id_or_slug, opts={})
         check_id_arg('venue', id_or_slug)
-        perform_get_request('venues/%s.json' % id_or_slug.to_s)
+        perform_get_request(format('venues/%s.json', id_or_slug.to_s), opts)
       end
 
-      # @option (see #get_tracks)
-      def get_venues(opts={})
-        perform_get_request('venues.json', select_params(opts, DEFAULT_PARAMS))
+      # Get many venues.
+      #
+      # @option opts (see #tracks)
+      def venues(opts={})
+        perform_get_request('venues.json', opts)
       end
 
 
 
-      def get_eras
-        perform_get_request('eras.json')
+      # Get eras.
+      #
+      # @option opts (see #track)
+      def eras(opts={})
+        perform_get_request('eras.json', opts)
       end
 
-      def get_years
-        perform_get_request('years.json')
+      # Get years.
+      #
+      # @option opts (see #track)
+      def years(opts={})
+        perform_get_request('years.json', opts)
       end
 
 
 
       # @api private
-      def select_params(opts, keys)
-        params = {}
+      def select_params(params, keys)
+        _params = {}
         keys.each do |key|
-          params[key] = opts[key] if opts.key?(key)
+          _params[key] = params[key] if params.key?(key)
         end
-        return params
+        return _params
       end
 
       # @api private
@@ -102,11 +141,21 @@ module Phishin
       end
 
       # @api private
-      def perform_get_request(path, params={})
+      def perform_get_request(path, opts)
+        opts ||= {}
         url = [BASE_URL, path].join("/")
-        logger.info "phish.in api GET url=#{url} params=#{params}" if logger
-        response = RestClient.get(url, HEADERS.merge(params: params))
-        resp = Phishin::Api::Response.new(url, Oj.load(response.to_s))
+        force  = opts.delete(:force)
+        params = opts.delete(:params) || {}
+        key = [path,
+                  [params.to_a.sort.map { |e| e.join('=')}].join('&')]
+                .join('?').chomp('?')
+
+        json_str = ::Phishin::Client::Cache.fetch(key, force: force) do
+          logger.info "phish.in api GET url=#{url} params=#{params}" if logger
+          RestClient.get(url, HEADERS.merge(params: params)).to_s
+        end
+
+        resp = Phishin::Api::Response.new(url, JSON.load(json_str))
         assert_response_data_field(resp)
         return resp
       end

data/lib/phishin/client/cache.rb

@@ -0,0 +1,128 @@
+module Phishin
+  module Client
+    class Cache
+
+      CACHE_NAMESPACE = 'phishin-client'
+
+      class << self
+
+        @enabled = nil
+        @underlying_cache = nil
+
+        # @api private
+        def setup(opts={})
+          @enabled = true
+
+          #require 'dalli'
+          #@underlying_cache = MemcachedCache.new(opts)
+          require 'redis'
+          @underlying_cache = RedisCache.new(opts)
+        end
+
+        # @api private
+        def should_cache?
+          return @enabled && !!@underlying_cache
+        end
+
+        def enable
+          @enabled = true
+        end
+
+        def disable
+          @enabled = false
+        end
+
+        def read(key)
+          return nil unless should_cache?
+
+          val = @underlying_cache.get(key)
+          log_cache_action('read', key, val) if val
+          return val
+        end
+
+        def write(key, value, ttl=nil)
+          return nil unless should_cache?
+
+          log_cache_action('write', key, value)
+          @underlying_cache.set(key, value, ttl)
+        end
+
+        def delete(key)
+          return nil unless should_cache?
+
+          val = @underlying_cache.delete(key)
+          log_cache_action('delete', key) if val
+          return val
+        end
+
+        # @api private
+        def log_cache_action(action, key, val=nil)
+          ::Phishin::Client::Client.logger.info "phish.in cache #{action} key=#{key[0..8]}" if ::Phishin::Client::Client.logger
+        end
+
+        # @option opts [Integer] :ttl time to live
+        # @option opts [Boolean] :force don't use cache
+        def fetch(key, opts={})
+          ttl = opts.delete(:ttl)
+          force = opts.delete(:force)
+          value = read(key) unless force
+
+          if force || !value
+            value = yield
+            write(key, value, ttl) unless force
+          end
+          return value
+        end
+      end
+    end
+
+    class RedisCache
+      def initialize(opts={})
+        opts ||= {}
+        @expires_in = opts.delete(:expires_in)
+        url = opts.delete(:url)
+        @client = Redis.new(url: url)
+        cli = @client.client
+        ::Phishin::Client::Client.logger.info "initialized phish.in cache Redis client redis://:REDACTED@#{cli.host}:#{cli.port}/#{cli.db}" if ::Phishin::Client::Client.logger
+      end
+
+      def get(key)
+        @client.get(namespace_key(key))
+      end
+
+      def set(key, value, ttl=nil)
+        ttl ||= @expires_in
+        @client.set(namespace_key(key), value, { ex: ttl })
+      end
+
+      def delete(key)
+        @client.del(namespace_key(key))
+      end
+
+      private
+
+      def namespace_key(key)
+        format('%s:%s', Cache::CACHE_NAMESPACE, key)
+      end
+    end
+
+    class MemcachedCache
+      def initialize(opts={})
+        expires_in = opts[:expires_in] || nil
+        servers    = opts[:servers]
+        @client = Dalli::Client.new(servers, namespace: Cache::CACHE_NAMESPACE, expires_in: expires_in)
+      end
+
+      def get(key)
+      end
+
+      def set(key, value, ttl=nil)
+        @client.set(key, value, ttl)
+      end
+
+      def delete(key)
+      end
+    end
+  end
+end
+

data/lib/phishin/client/client.rb

@@ -4,20 +4,53 @@ module Phishin
 
       include Phishin::Api::V1
 
-      attr_accessor :logger
-
       DEFAULT_LOGGER = lambda do
         require 'logger'
         logger = Logger.new(STDOUT)
         logger.progname = 'phishin-client'
+        formatter = Logger::Formatter.new
+        logger.formatter = proc { |severity, datetime, progname, msg|
+          formatter.call(severity, datetime, progname, msg)
+        }
         logger
       end
 
-      # @option opts [Boolean] :log Enable/disable logging
-      # @option opts [Object] :logger Logger-compatible object instance to use
+      # @param opts [Hash] options hash.
+      # @option opts [Boolean] :log Enable/disable logging.
+      # @option opts [Object] :logger Logger-compatible object instance to use.
+      # @option opts [Boolean] :cache (true) Enable/disable caching.
+      # @option opts [Hash] :cache_options options to pass along to the cache.
+      #   Leave blank to disable caching.
       def initialize(opts={})
-        opts[:log] = true if !opts.key?(:log)
-        @logger = opts[:log] ? (opts[:logger] || DEFAULT_LOGGER.call()) : nil
+        opts ||= {}
+        opts[:log]   = true if !opts.key?(:log)
+        cache = opts[:cache] || true
+        self.class.logger = opts[:log] ? (opts[:logger] || DEFAULT_LOGGER.call()) : nil
+
+        if cache
+          ::Phishin::Client::Cache.setup(opts[:cache_options])
+        end
+      end
+
+      def logger
+        return ::Phishin::Client::Client.logger
+      end
+
+      def logger=(logger)
+        ::Phishin::Client::Client.logger = logger
+      end
+
+      class << self
+
+        @logger = nil
+
+        def logger
+          @logger
+        end
+
+        def logger=(logger)
+          @logger = logger
+        end
       end
     end
   end

data/lib/phishin/client/version.rb

@@ -1,6 +1,6 @@
 module Phishin
   module Client
-    VERSION = '0.0.2'
+    VERSION = '0.0.3'
   end
 end
 

data/lib/phishin/client.rb

@@ -1,11 +1,13 @@
 require 'rest-client'
 require 'oj'
+require 'hashie'
 
 require 'phishin/api'
 require 'phishin/api/v1'
 require 'phishin/api/response'
 
 require 'phishin/client/version'
+require 'phishin/client/cache'
 require 'phishin/client/client'
 require 'phishin/client/errors'
 

data/phishin-client.gemspec

@@ -21,7 +21,10 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_runtime_dependency "rest-client", "~> 1.6.7"
-  spec.add_runtime_dependency "oj", "~> 2.8.1"
+  spec.add_runtime_dependency "json", "~> 1.8.1"
+  spec.add_runtime_dependency "hashie", "~> 2.1.1"
+  spec.add_runtime_dependency "dalli", "~> 2.7.0"
+  spec.add_runtime_dependency "redis", "~> 3.0.5"
   spec.add_development_dependency "bundler", "~> 1.6"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "yard", "~> 0.8"

metadata

@@ -1,83 +1,125 @@
 --- !ruby/object:Gem::Specification
 name: phishin-client
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Alex Bird
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-29 00:00:00.000000000 Z
+date: 2014-06-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.6.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.6.7
 - !ruby/object:Gem::Dependency
-  name: oj
+  name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.8.1
+        version: 1.8.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.8.1
+        version: 1.8.1
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.1
+- !ruby/object:Gem::Dependency
+  name: dalli
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.7.0
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.5
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
 - !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: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.8'
 description: Client for http://phish.in Phish streaming API.
@@ -87,7 +129,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -97,6 +139,7 @@ files:
 - lib/phishin/api/response.rb
 - lib/phishin/api/v1.rb
 - lib/phishin/client.rb
+- lib/phishin/client/cache.rb
 - lib/phishin/client/client.rb
 - lib/phishin/client/errors.rb
 - lib/phishin/client/version.rb
@@ -111,17 +154,17 @@ 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.0.14
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Phish.in API client