vibe 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 572f86112bab6191738be93ce7f36014f12e764e
-  data.tar.gz: a273852fd99843b808095f012054822f4dfd134c
+  metadata.gz: d995065c644162bb30adbc920ae3272a6221ccfb
+  data.tar.gz: 434fce7d0cbaaa953f652d4455fe2a8b8a3d5144
 SHA512:
-  metadata.gz: c7446c1be177bcaa1a8c8b7b7deb721bf44c0205c78e44966cb707846fd1de73e95cf9f9b9bbdd5df8cdb84c8d9e15a8ce570925cd8582a6c4ea71900e5fcc4c
-  data.tar.gz: 96293a87ce562ae4cd8e353d33c5cd2ccc99d58636cee83b243df843c0cd115bd0c43ae7003386ccc6a26c8d0af268c35563b01c6e4f6ce481add233a4c6e23b
+  metadata.gz: 0fa8e1be38624e4c3a4685e268fcd2bebf60118f3c8469d1f9b4536e15a4939d0dfd1c4802dd28e97c5660f2be82d94905356723b2c9c86b5cbaea3a191604a9
+  data.tar.gz: c8d2d0c62f8064fb84cc9ea153bad0bb4abd3b15d2bba5d61a197d187e5dec6c40b34d569effd31afaa9550ae5e9b9944346783bacbd444a734e0ec6e295d0c0

data/Gemfile.lock

@@ -7,7 +7,8 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    mime-types (2.4.2)
+    mime-types (2.4.3)
+    minitest (5.4.2)
     netrc (0.8.0)
     rake (10.1.0)
     rest-client (1.7.2)
@@ -19,5 +20,6 @@ PLATFORMS
 
 DEPENDENCIES
   bundler (~> 1.7)
+  minitest (~> 5.4.2)
   rake (~> 10.0)
   vibe!

data/README.md

@@ -10,7 +10,7 @@ Vibe API
 
 [RDocs](http://rubydoc.info/github/amalfra/vibe/master/frames)
 
-A Ruby wrapper for the Vibe REST API. 
+A Ruby wrapper for the Vibe REST API.
 
 > Get API key here : https://vibeapp.co/dev/
 
@@ -36,7 +36,7 @@ Create a new instance
 vibe = Vibe.new
 ```
 
-At this stage you can also supply the configuration parameter `:api_key` which is used throughout the API. These can be passed directly as hash options:
+At this stage you can also supply the configuration parameter `:api_key`, `:cache` which is used throughout the API. These can be passed directly as hash options:
 
 ```ruby
 vibe = Vibe.new api_key: 'api_key'
@@ -47,15 +47,21 @@ Alternatively, you can configure the Vibe settings by passing a block:
 ```ruby
 vibe = Vibe.new do |config|
   config.api_key   = 'api_key'
+  config.cache     = false # Maybe i need to turn off cache
 end
 ```
 
+## Cache
+
+The wrapper has Cache feature which would cache API response for a day. **The stats API call which is used to get the status of an API key won't be cached**. The currently supported Cache methods are:
+ * File: Stored in system temporary path.
+
 ## API
 
-The currently available api methods are :
+The currently available api methods are:
  * get_data(email) - Get Data from an Email
  * stats           - Get Stats for API Key. If API key parameter is not
-                     passed then the one in config will be used 
+                     passed then the one in config will be used
 
 
 ## Development

data/lib/vibe.rb

@@ -1,4 +1,5 @@
-%w{version error configuration client}.each do |local|
+%w{version error configuration cache client}.each do |local|
+  puts "Including #{local}" if ENV['DEBUG']
   require "vibe/#{local}"
 end
 
@@ -8,7 +9,7 @@ module Vibe
   # Alias for Vibe::Client.new
   #
   # @return [Vibe::Client]
-  def self.new(options = { }, &block)
+  def self.new(options = {}, &block)
     @api_client = Vibe::Client.new(options, &block)
   end
 end

data/lib/vibe/cache-drivers/file.rb

@@ -0,0 +1,56 @@
+module Vibe
+  class File
+
+    def initialize(cache_dir = '')
+      # Cache directory in sys temp path if not
+      # explicitly set
+      @cache_dir = Dir.tmpdir()+'/vibe_gem/' if cache_dir == ''
+
+      if !Dir.exists?(@cache_dir)
+          Dir.mkdir(@cache_dir)
+      end
+    end
+
+    # Get content from cache file. This function would
+    # delete cache if expired(Older than a day)
+    #
+    # @return [Boolean]
+    def get(key = '')
+      if key != '' && ::File.exists?(@cache_dir+key)
+        # Is the File older than a day?
+        if file_age(@cache_dir+key) > 1
+          # Delete and return a cache miss
+          File.delete(@cache_dir+key)
+          return false
+        end
+
+        puts "Reading from cache with key: #{key}" if ENV['DEBUG']
+        data = ::File.read(@cache_dir+key)
+        return (data.length > 0) ? data : false
+      end
+
+      return false
+    end
+
+    # Write content into cache file
+    #
+    # @return [Boolean]
+    def put(key = '', data = '')
+      if key != '' && data != ''
+        puts "Writing into cache with key: #{key}" if ENV['DEBUG']
+        return ::File.write(@cache_dir+key, data)
+      end
+
+      return false
+    end
+
+    # Return the number of days since the file
+    # was last modified
+    #
+    # @return [Int]
+    def file_age(name)
+      (Time.now - ::File.stat(name).mtime)/(24*3600)
+    end
+
+  end # File
+end

data/lib/vibe/cache.rb

@@ -0,0 +1,37 @@
+module Vibe
+  class Cache
+
+    extend Configuration
+    include Error
+
+    DRIVERS = ['FILE']
+
+    def initialize(options = {})
+      # If invalid cache driver given
+      if options.include?(:driver) && !DRIVERS.include?(options[:driver])
+        raise ArgumentError, "unkown cache driver: #{options[:driver]}"
+      else
+        # Load the required cache driver
+        require "vibe/cache-drivers/#{options[:driver].downcase}"
+        @driver = eval(options[:driver].downcase.capitalize).new
+      end
+    end
+
+    # Get key from cache, proxies into
+    # method with same name in driver class
+    #
+    # @return [Driver.get]
+    def get(key = '')
+      @driver.get(key)
+    end
+
+    # Write to cache, proxies into
+    # method with same name in driver class
+    #
+    # @return [Driver.put]
+    def put(key = '', data = '')
+      @driver.put(key, data)
+    end
+
+  end # Cache
+end

data/lib/vibe/client.rb

@@ -7,7 +7,7 @@ module Vibe
 
     attr_accessor   *Configuration::VALID_CONFIG_KEYS
 
-    def initialize(options={}, &block)
+    def initialize(options = {}, &block)
       # Merge the config values from the module and those passed
       # to the client.
       merged_options = Vibe.options.merge(options)
@@ -15,6 +15,7 @@ module Vibe
       # Copy the merged values and ignore those
       # not part of our configuration
       Configuration::VALID_CONFIG_KEYS.each do |key|
+        puts "Setting Configuration: #{key}" if ENV['DEBUG']
         send("#{key}=", merged_options[key]) if Configuration::VALID_OPTIONS_KEYS.include? key
         send("#{key}=", Vibe.options[key]) if Configuration::VALID_CONNECTION_KEYS.include? key
       end
@@ -23,8 +24,10 @@ module Vibe
     end
 
     # Get Data from an Email
+    #
+    # @return [String]
     def get_data(email)
-      if !email.is_a? String 
+      if !email.is_a? String
         error = InvalidOptions.new(['Email(String)'], ['Email(String)'])
         raise error
       end
@@ -33,13 +36,16 @@ module Vibe
     end
 
     # Get Stats for API Key
+    #
+    # @return [String]
     def stats(api_key = nil)
       if api_key && (!api_key.is_a? String)
         error = InvalidOptions.new(['API key(String)'], ['API key(String)'])
         raise error
       end
 
-      get_request '/api_stats', :api_key => api_key
+      # Disable cache for API key status calls
+      get_request('/api_stats', {:api_key => api_key}, true)
     end
 
   end # Client

data/lib/vibe/configuration.rb

@@ -1,46 +1,54 @@
 module Vibe
   module Configuration
     VALID_CONNECTION_KEYS = [:endpoint, :user_agent, :method, :format].freeze
-    VALID_OPTIONS_KEYS    = [:api_key].freeze
+    VALID_OPTIONS_KEYS    = [:api_key, :cache, :cache_driver].freeze
     VALID_CONFIG_KEYS     = VALID_CONNECTION_KEYS + VALID_OPTIONS_KEYS
- 
-    DEFAULT_ENDPOINT    = 'https://vibeapp.co/api/v1/'.freeze
-    DEFAULT_METHOD      = :get.freeze
-    DEFAULT_USER_AGENT  = "Vibe API Ruby Gem #{Vibe::VERSION}".freeze
- 
-    DEFAULT_API_KEY      = nil
-    DEFAULT_FORMAT       = :json.freeze
- 
+
+    DEFAULT_ENDPOINT      = 'https://vibeapp.co/api/v1/'.freeze
+    DEFAULT_METHOD        = :get.freeze
+    DEFAULT_USER_AGENT    = "Vibe API Ruby Gem #{Vibe::VERSION}".freeze
+
+    DEFAULT_API_KEY       = nil
+    DEFAULT_FORMAT        = :json.freeze
+
+    DEFAULT_CACHE_DRIVER  = 'FILE'.freeze
+    DEFAULT_CACHE         = true
+
     # Build accessor methods for every config options so we can do this
     attr_accessor *Configuration::VALID_CONFIG_KEYS
- 
-    def initialize
-      self.endpoint   = DEFAULT_ENDPOINT
-      self.method     = DEFAULT_METHOD
-      self.user_agent = DEFAULT_USER_AGENT
-      self.format     = DEFAULT_FORMAT
-    end
+
+    @endpoint     = DEFAULT_ENDPOINT
+    @method       = DEFAULT_METHOD
+    @user_agent   = DEFAULT_USER_AGENT
+    @format       = DEFAULT_FORMAT
+    @cache_driver = DEFAULT_CACHE_DRIVER
+    @cache        = DEFAULT_CACHE
 
     # Make sure we have the default values set when we get 'extended'
     def self.extended(base)
       base.reset
     end
- 
+
     # Setup Configuration
     def configure
       yield self
     end
 
+    # Reset config values to default
     def reset
-      self.endpoint   = DEFAULT_ENDPOINT
-      self.method     = DEFAULT_METHOD
-      self.user_agent = DEFAULT_USER_AGENT
-      self.format     = DEFAULT_FORMAT
+      self.endpoint     = DEFAULT_ENDPOINT
+      self.method       = DEFAULT_METHOD
+      self.user_agent   = DEFAULT_USER_AGENT
+      self.format       = DEFAULT_FORMAT
 
-      self.api_key    = DEFAULT_API_KEY
+      self.api_key      = DEFAULT_API_KEY
+      self.cache_driver = DEFAULT_CACHE_DRIVER
+      self.cache        = true
     end
- 
+
     # Return the configuration values set in this module
+    #
+    # @return [Hash]
     def options
       Hash[ * VALID_CONFIG_KEYS.map { |key| [key, send(key)] }.flatten ]
     end

data/lib/vibe/request.rb

@@ -8,21 +8,44 @@ module Vibe
 
     METHODS = [:get, :post, :put, :delete, :patch]
 
-    def get_request(path, params={})
-      request(:get, path, params)
+    # Perform a GET HTTP request
+    #
+    # @return [Request.request]
+    def get_request(path, params = {}, cache_override = false)
+      request(:get, path, params, cache_override)
     end
 
-    def request(method, path, params)
+    # Execute an HTTP request and return the result
+    # Exceptions would be raised based on HTTP status codes
+    #
+    # @return [String]
+    def request(method, path, params, cache_override = false)
       if !METHODS.include?(method)
-	raise ArgumentError, "unkown http method: #{method}"
+	      raise ArgumentError, "unkown http method: #{method}"
+      end
+
+      # Is caching activated?
+      if cache && !cache_override
+        cache = Cache.new driver: cache_driver
+
+        # Check if cache present
+        param_string = params.map{|k,v| "#{k}-#{v}"}.join(':')
+        filename = Digest::MD5.hexdigest(method.to_s.gsub("/", "_")+path.to_s.gsub("/", "_")+param_string).freeze
+        response = cache.get(filename)
+
+        if response
+          return JSON.parse(response)
+        end
       end
 
       if !api_key
-        raise ClientError, 'API key need to be set' 
+        raise ClientError, 'API key need to be set'
       end
 
       puts "EXECUTED: #{method} - #{path} with #{params}" if ENV['DEBUG']
 
+      # If API key is passed as a paramter then ignore the one
+      # set in config
       if params[:api_key]
         new_api_key = params[:api_key]
         params = params.tap { |hs| hs.delete(:api_key) }
@@ -34,6 +57,7 @@ module Vibe
       begin
         puts params if ENV['DEBUG']
         response = RestClient.send("#{method}", endpoint + path.gsub!(/^\//, ""), :params => params){ |response, request, result, &block|
+          # Go through redirection based on status code
           if [301, 302, 307].include? response.code
             response.follow_redirection(request, result, &block)
           elsif !response.code.between?(200, 400)
@@ -50,11 +74,20 @@ module Vibe
                 raise ServiceError, {:status => response.code, :method => method, :response_headers => response.headers, :url => endpoint + path, :body => "API Returned status code #{response.code}"}
               end
           else
+            # Is caching activated?
+            if cache
+              # Put into cache
+              if !cache.put(filename, response)
+                raise ClientError, 'Unable to write into Cache'
+              end
+            end
+
+            # Parse JSON response
             JSON.parse(response)
           end
         }
       rescue SocketError => e
-        raise VibeError, 'xgcv'
+        raise VibeError, 'SocketError Occured!'
       end
 
     end

data/lib/vibe/version.rb

@@ -1,3 +1,3 @@
 module Vibe
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/test/helper.rb

@@ -1,3 +1,3 @@
-require 'vibe'
 require 'minitest/spec'
 require 'minitest/autorun'
+require 'vibe'

data/vibe.gemspec

@@ -18,8 +18,11 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  spec.required_ruby_version = '>= 1.9.3'
+
   spec.add_dependency "rest-client", "~> 1.7"
 
   spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.4.2"
 end

metadata

@@ -1,57 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: vibe
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Amal Francis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-20 00:00:00.000000000 Z
+date: 2014-10-30 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.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.7'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.7'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 5.4.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 5.4.2
 description: A Ruby wrapper for the Vibe REST API
 email:
 - amalfra@gmail.com
@@ -59,13 +73,15 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
+- .gitignore
 - Gemfile
 - Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
 - lib/vibe.rb
+- lib/vibe/cache-drivers/file.rb
+- lib/vibe/cache.rb
 - lib/vibe/client.rb
 - lib/vibe/configuration.rb
 - lib/vibe/error.rb
@@ -99,17 +115,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.3.0
 signing_key: 
 specification_version: 4
 summary: A Ruby wrapper for the Vibe REST API