fredric 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aeded696850394a227db2c59808569535a5d330f
-  data.tar.gz: f27002ee98c5af408210938274f60f3980fc79b8
+  metadata.gz: 96f4e8baa0924d813a417ee8a53b4803880e6702
+  data.tar.gz: 808a86c0fa40ec9efba531f567c6ddf254a95af4
 SHA512:
-  metadata.gz: f23601ce059eecc8db1eb283a25a00df26228f61894449d155dcdbc9e1277ca0a8bd425ebc4d6f59b849c46b35f4e0539c878ca6555a43e7381cbaeb57481cd4
-  data.tar.gz: fe256721ce32f02248f9d5118bac89213d7a25ac62f1c1ab26a8708d56836366cfd8f4bb1ba99e028ed3f1247fcc90e42564131df1734842456a6be8ee109191
+  metadata.gz: 4e61e43908040861fbb839837875d54fc2f58aed0b08790cb7961b20dbd79ed89b52ee44985f9bdc0e9b2d966e89b2307a760e75609612137ff9ba38ac03ef70
+  data.tar.gz: 013046475b9fb0471b7b70170bb8e7c6c8e2bd23260a35d7ec19280c56901b5514ff4fcda369976a0684f13853bd1aab50cd0e71039ef1d938848ceb4bc605ac

data/README.md

@@ -77,12 +77,37 @@ fredric.get 'endpoint/sub', param: value
 fredric.endpoint 'sub', param: value
 ```
 
-By default, you will get a ruby hash in return. If you wish to get the raw
-output, you can use the `get!` method:
+By default, you will get a ruby hash in return. If you wish to have more 
+control over the response, use the `get!` method instead:
 
 ```ruby
 result = fredric.get! "series/ovservations", series_id: 'GNPCA'
+
+# Request Object
+p payload.request.class
+# => HTTParty::Request
+
+# Response Object
+p payload.response.class
+# => Net::HTTPOK
+
+p payload.response.body
 # => JSON string
+
+p payload.response.code
+# => 200
+
+p payload.response.msg
+# => OK
+
+# Headers Object
+p payload.headers
+# => Hash with headers
+
+# Parsed Response Object
+p payload.parsed_response
+# => Hash with HTTParty parsed response 
+#    (this is the content returned with #get)
 ```
 
 You can get the response as CSV by calling `get_csv`:
@@ -109,17 +134,6 @@ Or, to save CSV, use the `save_csv` method:
 fredric.save_csv "filename.csv", "series/overvations", series_id: 'GNPCA'
 ```
 
-Debugging your request and adding "sticky" query parameters that stay with
-you for the following requests is also easy:
-
-```ruby
-fredric.debug = true
-fredric.param limit: 10, sort_order: :asc, file_type: :xml
-puts fredric.series 'observations', series_id: 'GNPCA'
-# => https://api.stlouisfed.org/fred/series/observations?api_key=...&file_type=xml&limit=10&sort_order=asc&series_id=GNPCA
-
-fredric.param sort_order: nil # remove param
-```
 
 
 Command Line
@@ -166,11 +180,11 @@ $ fred url series/observations query:interest limit:5
 Caching
 --------------------------------------------------
 
-We are using the [WebCache][3] gem for automatic HTTP caching.
+We are using the [Lightly][3] gem for automatic HTTP caching.
 To take the path of least surprises, caching is disabled by default.
 
 You can enable and customize it by either passing options on 
-initialization, or by accessing the `WebCache` object directly at 
+initialization, or by accessing the `Lightly` object directly at 
 a later stage.
 
 ```ruby
@@ -199,6 +213,6 @@ $ fred see category/children
 
 [1]: https://research.stlouisfed.org/docs/api/fred/
 [2]: https://github.com/DannyBen/fredric/blob/master/lib/fredric/docopt.txt
-[3]: https://github.com/DannyBen/webcache
+[3]: https://github.com/DannyBen/lightly
 [4]: https://research.stlouisfed.org/docs/api/api_key.html
 

data/bin/fred

@@ -4,6 +4,6 @@ require 'fredric'
 
 begin
   Fredric::CommandLine.instance.execute ARGV
-rescue Fredric::BadResponse => e
+rescue APICake::BadResponse => e
   STDERR.puts "#{e.class} - #{e.message}"
 end

data/lib/fredric.rb

@@ -1,5 +1,4 @@
 require 'fredric/version'
 require 'fredric/exceptions'
-require 'fredric/web_api'
 require 'fredric/api'
 require 'fredric/command_line'

data/lib/fredric/api.rb

@@ -1,74 +1,22 @@
-require 'json'
-require 'csv'
+require 'apicake'
 
 module Fredric
-  # Provides access to all the FRED API endpoints
-  class API < WebAPI
-    attr_reader :api_key, :opts
+  # Provides access to all the FRED API endpoints with dynamic methods
+  # anc caching.
+  class API < APICake::Base
+    base_uri 'https://api.stlouisfed.org/fred'
+
+    attr_reader :api_key
 
     def initialize(api_key, opts={})
       @api_key = api_key
-
-      defaults = {
-        use_cache: false,
-        cache_dir: nil,
-        cache_life: nil,
-        base_url: "https://api.stlouisfed.org/fred"
-      }
-
-      opts = defaults.merge! opts
-      @opts = opts
-
       cache.disable unless opts[:use_cache]
       cache.dir = opts[:cache_dir] if opts[:cache_dir]
       cache.life = opts[:cache_life] if opts[:cache_life]
-
-      param api_key: api_key if api_key
-      param file_type: :json
-
-      after_request do |response| 
-        begin
-          JSON.parse response, symbolize_names: true
-        rescue JSON::ParserError
-          response
-        end
-      end
-      
-      super opts[:base_url]
-    end
-
-    def get_csv(*args)
-      response = get(*args)
-
-      raise Fredric::BadResponse, "API said '#{response}'" if response.is_a? String
-      raise Fredric::BadResponse, "Got a #{response.class}, expected a Hash" unless response.is_a? Hash
-      
-      data = csv_node response
-
-      header = data.first.keys
-      result = CSV.generate do |csv|
-        csv << header
-        data.each { |row| csv << row.values }
-      end
-
-      result
     end
 
-    def save_csv(file, *args)
-      data = get_csv(*args)
-      File.write file, data
-    end
-
-    private
-
-    # Determins which part of the data is best suited to be displayed 
-    # as CSV. 
-    # - In case there is an array in the data (like 'observations' or
-    #   'seriess'), it will be returned
-    # - Otherwise, we will use the entire response as a single row CSV
-    def csv_node(data)
-      arrays = data.keys.select { |key| data[key].is_a? Array }
-      arrays.empty? ? [data] : data[arrays.first]
+    def default_query
+      { api_key: api_key, file_type: :json } 
     end
   end
 end

data/lib/fredric/command_line.rb

@@ -56,7 +56,8 @@ module Fredric
       if csv
         puts fredric.get_csv path, params
       else
-        puts fredric.get! path, params
+        payload = fredric.get! path, params
+        puts payload.response.body
       end
     end
 
@@ -70,8 +71,8 @@ module Fredric
     end
 
     def pretty
-      response = fredric.get path, params
-      puts JSON.pretty_generate response
+      payload = fredric.get path, params
+      puts JSON.pretty_generate payload
     end
 
     def see
@@ -79,9 +80,7 @@ module Fredric
     end
 
     def url
-      fredric.debug = true
-      puts fredric.get path, params
-      fredric.debug = false
+      puts fredric.url path, params
     end
 
     # Convert a params array like [key:value, key:value] to a hash like

data/lib/fredric/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fredric
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-11 00:00:00.000000000 Z
+date: 2017-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: docopt
@@ -39,19 +39,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.7'
 - !ruby/object:Gem::Dependency
-  name: webcache
+  name: apicake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '0.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: runfile
   requirement: !ruby/object:Gem::Requirement
@@ -166,7 +166,6 @@ files:
 - lib/fredric/docopt.txt
 - lib/fredric/exceptions.rb
 - lib/fredric/version.rb
-- lib/fredric/web_api.rb
 homepage: https://github.com/DannyBen/fredric
 licenses:
 - MIT

data/lib/fredric/web_api.rb

@@ -1,93 +0,0 @@
-require 'uri'
-require 'open-uri'
-require 'webcache'
-
-module Fredric
-
-  # A general purpose HTTP wrapper. This is poor man's HTTParty with
-  # dynamic methods.
-  class WebAPI
-    attr_reader :base_url, :after_request_block, :last_error
-    attr_accessor :debug, :format
-
-    def initialize(base_url)
-      @base_url = base_url
-    end
-
-    # Allow using any method as the first segment of the path
-    # object.user 'details' becomes object.get 'user/details'
-    def method_missing(method_sym, *arguments, &_block)
-      get "/#{method_sym}", *arguments
-    end
-
-    # Add one or more parameter to the default query string. Good for 
-    # adding keys that are always needed, like API keys.
-    def param(params)
-      params.each do |key, value|
-        default_params[key] = value
-        default_params.delete key if value.nil?
-      end
-    end
-
-    def cache
-      @cache ||= WebCache.new
-    end
-
-    # Set a block to be executed after the request. This is called only when
-    # using `get` and not when using `get!`. Good for JSON decoding, for 
-    # example.
-    def after_request(&block)
-      @after_request_block = block
-    end
-
-    # Return the response from the API. 
-    def get(path, extra=nil, params={})
-      response = get! path, extra, params
-      response = after_request_block.call(response) if after_request_block
-      response
-    end
-
-    # Return the response from the API, without executing the after_request
-    # block.
-    def get!(path, extra=nil, params={})
-      if extra.is_a?(Hash) and params.empty?
-        params = extra
-        extra = nil
-      end
-
-      path = "#{path}/#{extra}" if extra
-      url = construct_url path, params
-
-      return url if debug 
-
-      response = cache.get(url)
-      @last_error = response.error
-      response.content
-    end
-
-    # Save the response from the API to a file.
-    def save(filename, path, params={})
-      response = get! path, nil, params
-      return response if debug
-      File.write filename, response.to_s
-    end
-
-    # Build a URL from all its explicit and implicit pieces.
-    def construct_url(path, params={})
-      path = "/#{path}" unless path[0] == '/'
-      all_params = default_params.merge params
-      result = "#{base_url}#{path}"
-      result = "#{result}.#{format}" if format && File.extname(result) == ''
-      unless all_params.empty?
-        all_params = URI.encode_www_form all_params
-        result = "#{result}?#{all_params}"
-      end
-      result
-    end
-
-    def default_params
-      @default_params ||= {}
-    end
-
-  end
-end