fredapi 1.0.0

data/lib/fredapi/client/series/vintage_dates.rb

@@ -0,0 +1,27 @@
+module FREDAPI
+  class Client
+    module Series
+      # VintageDates module for fred/series/vintagedates endpoint
+      module VintageDates
+
+        # Get the dates in history when a series' data values
+        # were revised or new data values were released
+        #
+        # @param opts [Hash] options hash of parameters
+        # @option opts [Integer] api_key 32 character alpha-numeric lowercase string
+        # @option opts [String] file_type A key or file extension that indicates the type of file to send
+        # @option opts [Integer] series_id The id for a series
+        # @option opts [String] realtime_start The start of the real-time period
+        # @option opts [String] realtime_end The end of the real-time period
+        # @option opts [Integer] limit The maximum number of results to return
+        # @option opts [Integer] offset Non-negative integer
+        # @option opts [String] sort_order Sort results is ascending or descending order for attribute values specified by order_by
+        # @return [Hashie::Mash] Hash containing the results
+        def series_vintage_dates opts={}
+          get "fred/series/vintagedates", opts
+        end
+
+      end
+    end
+  end
+end

data/lib/fredapi/client/source.rb

@@ -0,0 +1,25 @@
+require 'fredapi/client/source/releases'
+
+module FREDAPI
+  class Client
+    # Source module for fred/source endpoint
+    module Source
+
+      # Get a source of economic data
+      #
+      # @param opts [Hash] options hash of parameters
+      # @option opts [Integer] api_key 32 character alpha-numeric lowercase string
+      # @option opts [String] file_type A key or file extension that indicates the type of file to send
+      # @option opts [Integer] source_id The id for a source
+      # @option opts [String] realtime_start The start of the real-time period
+      # @option opts [String] realtime_end The end of the real-time period
+      # @return [Hashie::Mash] Hash containing the results
+      def source opts={}
+        get "fred/source", opts
+      end
+
+      include FREDAPI::Client::Source::Releases
+
+    end
+  end
+end

data/lib/fredapi/client/source/releases.rb

@@ -0,0 +1,27 @@
+module FREDAPI
+  class Client
+    module Source
+    # Releases module for fred/source/releases endpoint
+      module Releases
+
+        # Get the releases for a source
+        #
+        # @param opts [Hash] options hash of parameters
+        # @option opts [Integer] api_key 32 character alpha-numeric lowercase string
+        # @option opts [String] file_type A key or file extension that indicates the type
+        # @option opts [Integer] source_id The id for a source
+        # @option opts [String] realtime_start The start of the real-time period
+        # @option opts [String] realtime_end The end of the real-time period
+        # @option opts [Integer] limit The maximum number of results to return
+        # @option opts [Integer] offset Non-negative integer
+        # @option opts [String] order_by Order results by values of the specified attribute
+        # @option opts [String] sort_order Sort results is ascending or descending order for attribute values specified by order_by
+        # @return [Hashie::Mash] Hash containing the results
+        def source_releases opts={}
+          get "fred/source/releases", opts
+        end
+
+      end
+    end
+  end
+end

data/lib/fredapi/client/sources.rb

@@ -0,0 +1,24 @@
+module FREDAPI
+  class Client
+    # Sources module for fred/sources endpoint
+    module Sources
+
+      # Get all sources of economic data
+      #
+      # @param opts [Hash] options hash of parameters
+      # @option opts [Integer] api_key 32 character alpha-numeric lowercase string
+      # @option opts [String] file_type A key or file extension that indicates the type of file to send
+      # @option opts [String] realtime_start The start of the real-time period
+      # @option opts [String] realtime_end The end of the real-time period
+      # @option opts [Integer] limit The maximum number of results to return
+      # @option opts [Integer] offset Non-negative integer
+      # @option opts [String] order_by Order results by values of the specified attribute
+      # @option opts [String] sort_order Sort results is ascending or descending order for attribute values specified by order_by
+      # @return [Hashie::Mash] Hash containing the results
+      def sources opts={}
+        get "fred/sources", opts
+      end
+
+    end
+  end
+end

data/lib/fredapi/client/tags.rb

@@ -0,0 +1,31 @@
+require 'fredapi/client/tags/series'
+
+module FREDAPI
+  class Client
+    # Tags module for fred/tags endpoint
+    module Tags
+
+      # Get all tags, search for tags, or get tags by name
+      #
+      # @param opts [Hash] options hash of parameters
+      # @option opts [Integer] api_key 32 character alpha-numeric lowercase string
+      # @option opts [String] file_type A key or file extension that indicates the type of file to send
+      # @option opts [String] realtime_start The start of the real-time period
+      # @option opts [String] realtime_end The end of the real-time period
+      # @option opts [String] tag_group_id A tag group id to filter tags by type
+      # @option opts [String] tag_names A semicolon delimited list of tags to find related tags for
+      # @option opts [String] search_text The words to find matching tags with
+      # @option opts [Integer] limit The maximum number of results to return
+      # @option opts [Integer] offset Non-negative integer
+      # @option opts [String] order_by Order results by values of the specified attribute
+      # @option opts [String] sort_order Sort results is ascending or descending order for attribute values specified by order_by
+      # @return [Hashie::Mash] Hash containing the results
+      def tags opts={}
+        get "fred/tags", opts
+      end
+
+      include FREDAPI::Client::Tags::Series
+
+    end
+  end
+end

data/lib/fredapi/client/tags/series.rb

@@ -0,0 +1,27 @@
+module FREDAPI
+  class Client
+    module Tags
+      # Series module for fred/tags/series endpoint
+      module Series
+
+        # Get the series matching tags
+        #
+        # @param opts [Hash] options hash of parameters
+        # @option opts [Integer] api_key 32 character alpha-numeric lowercase string
+        # @option opts [String] file_type A key or file extension that indicates the type
+        # @option opts [String] tag_names A semicolon delimited list of tags to find related tags for
+        # @option opts [String] realtime_start The start of the real-time period
+        # @option opts [String] realtime_end The end of the real-time period
+        # @option opts [Integer] limit The maximum number of results to return
+        # @option opts [Integer] offset Non-negative integer
+        # @option opts [String] order_by Order results by values of the specified attribute
+        # @option opts [String] sort_order Sort results is ascending or descending order for attribute values specified by order_by
+        # @return [Hashie::Mash] Hash containing the results
+        def tags_series opts={}
+          get "fred/tags/series", opts
+        end
+
+      end
+    end
+  end
+end

data/lib/fredapi/configuration.rb

@@ -0,0 +1,45 @@
+require 'faraday'
+
+module FREDAPI
+  # Configuration module to set default and custom client credentials
+  module Configuration
+
+    OPTION_KEYS = [
+      'adapter',
+      'api_endpoint',
+      'user_agent',
+      'api_key',
+      'file_type'
+    ].freeze
+
+    DEFAULT_ADAPTER       = Faraday.default_adapter
+    DEFAULT_API_ENDPOINT  = 'http://api.stlouisfed.org/'
+    DEFAULT_USER_AGENT    = "FREDAPI Ruby Gem #{FREDAPI::VERSION}".freeze
+    DEFAULT_FILE_TYPE     = 'json'
+
+    attr_accessor *OPTION_KEYS
+
+    # Extend hook
+    def self.extended(base)
+      base.reset
+    end
+
+    # Set configuration options using a block
+    def configure
+      yield self
+    end
+
+    # Convert option_keys to hash and return
+    def options
+      OPTION_KEYS.inject({}){|o,k|o.merge!(k => send(k))}
+    end
+
+    # Reset the configuration options
+    def reset
+      self.adapter      = DEFAULT_ADAPTER
+      self.user_agent   = DEFAULT_USER_AGENT
+      self.api_endpoint = DEFAULT_API_ENDPOINT
+      self.file_type    = DEFAULT_FILE_TYPE
+    end
+  end
+end

data/lib/fredapi/connection.rb

@@ -0,0 +1,32 @@
+require 'faraday_middleware'
+require 'faraday/utils/utils'
+
+module FREDAPI
+  # Connection module to handle requests
+  module Connection
+    private
+
+    # Create a connection to send request
+    def connection opts={}
+      connection = Faraday.new(opts) do |conn|
+
+        if opts[:force_urlencoded]
+          conn.request :url_encoded
+        else
+          conn.request :json
+        end
+
+        conn.request :json
+        conn.use FaradayMiddleware::FollowRedirects
+        conn.use FaradayMiddleware::Mashify
+        conn.use FaradayMiddleware::ParseJson, :content_type => /\bjson$/
+        conn.use FaradayMiddleware::ParseXml, :content_type => /\bxml$/
+        conn.adapter adapter
+      end
+
+      connection.headers[:user_agent] = user_agent
+      connection
+    end
+
+  end
+end

data/lib/fredapi/request.rb

@@ -0,0 +1,98 @@
+require 'multi_json'
+
+module FREDAPI
+  # Request module to handle all requests to API
+  module Request
+
+    # Perform a get request
+    #
+    # @param path [String] URL path to send request
+    # @param opts [Hash] Request parameters
+    # @return [Hashie::Mash] Response body
+    def get path, opts={}
+      request(:get, path, opts).body
+    end
+
+    # Perform a delete request
+    #
+    # @param path [String] URL path to send request
+    # @param opts [Hash] Request parameters
+    # @return [Hashie::Mash] Response body
+    def delete path, opts={}
+      request(:delete, path, opts).body
+    end
+
+    # Perform a post request
+    #
+    # @param path [String] URL path to send request
+    # @param opts [Hash] Request parameters
+    # @return [Hashie::Mash] Response body
+    def post path, opts={}
+      request(:post, path, opts).body
+    end
+
+    # Perform a put request
+    #
+    # @param path [String] URL path to send request
+    # @param opts [Hash] Request parameters
+    # @return [Hashie::Mash] Response body
+    def put path, opts={}
+      request(:put, path, opts).body
+    end
+
+    # Perform a patch request
+    #
+    # @param path [String] URL path to send request
+    # @param opts [Hash] Request parameters
+    # @return [Hashie::Mash] Response body
+    def patch path, opts={}
+      request(:patch, path, opts).body
+    end
+
+    private
+
+    # Sets connection options
+    #
+    # @param opts [Hash] hash of opts passed
+    # @return [Hash] connection options
+    def connection_options opts
+      {
+        :headers => {
+          :user_agent => user_agent
+        },
+        :force_urlencoded => opts.delete(:force_urlencoded) || false,
+        :url => api_endpoint
+      }
+    end
+
+    # Perform a request
+    #
+    # @param method [String] Type of request path
+    # @param path [String] URL path to send request
+    # @param opts [Hash] Request parameters
+    # @return [Hashie::Mash] Response
+    def request method, path, opts={}
+      conn_options = connection_options opts
+      opts['api_key'] = api_key unless opts.has_key? 'api_key'
+      opts['file_type'] = file_type unless opts.has_key? 'file_type'
+
+      response = connection(conn_options).send(method) do |request|
+        case method
+        when :get
+          request.url path, opts
+        when :delete
+          request.url path, opts
+        when :patch, :post, :put
+          if conn_options[:force_urlencoded]
+            request.url path, opts
+          else
+            request.path = path
+            request.body = MultiJson.dump(opts) unless opts.empty?
+          end
+        end
+      end
+
+      response
+    end
+  end
+end

data/lib/fredapi/version.rb

@@ -0,0 +1,3 @@
+module FREDAPI
+  VERSION = "1.0.0"
+end

data/spec/fredapi_spec.rb

@@ -0,0 +1,23 @@
+require 'helper'
+
+describe FREDAPI do
+
+  describe 'when called' do
+    it 'should be an instance of Module' do
+      FREDAPI.should be_an_instance_of Module
+    end
+  end
+
+  describe '.new' do
+    it 'is a FREDAPI::Client' do
+      expect(FREDAPI.new).to be_a FREDAPI::Client
+    end
+  end
+
+  describe '.respond_to?' do
+    it 'returns true if new method exists' do
+      expect(FREDAPI.respond_to?(:new, true)).to eq(true)
+    end
+  end
+
+end

data/spec/helper.rb

@@ -0,0 +1,12 @@
+require 'coveralls'
+Coveralls.wear!
+require 'fredapi'
+
+RSpec.configure do |config|
+  config.color_enabled  = true
+  config.formatter      = :documentation
+end
+
+def fixture_path
+  File.expand_path("../fixtures", __FILE__)
+end

metadata

@@ -0,0 +1,163 @@
+--- !ruby/object:Gem::Specification
+name: fredapi
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jonathan Chrisp
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.13.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.13.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.12.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.12.2
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.5
+description: A Ruby wrapper for the FRED API
+email: jonathan.chrisp@gmail.com
+executables:
+- fredapi
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENCE.md
+- README.md
+- bin/fredapi
+- fredapi.gemspec
+- lib/faraday/utils/utils.rb
+- lib/fredapi.rb
+- lib/fredapi/client.rb
+- lib/fredapi/client/category.rb
+- lib/fredapi/client/category/children.rb
+- lib/fredapi/client/category/related.rb
+- lib/fredapi/client/category/related_tags.rb
+- lib/fredapi/client/category/series.rb
+- lib/fredapi/client/category/tags.rb
+- lib/fredapi/client/related_tags.rb
+- lib/fredapi/client/release.rb
+- lib/fredapi/client/release/dates.rb
+- lib/fredapi/client/release/related_tags.rb
+- lib/fredapi/client/release/series.rb
+- lib/fredapi/client/release/sources.rb
+- lib/fredapi/client/release/tags.rb
+- lib/fredapi/client/releases.rb
+- lib/fredapi/client/releases/dates.rb
+- lib/fredapi/client/series.rb
+- lib/fredapi/client/series/categories.rb
+- lib/fredapi/client/series/observations.rb
+- lib/fredapi/client/series/release.rb
+- lib/fredapi/client/series/search.rb
+- lib/fredapi/client/series/search/related_tags.rb
+- lib/fredapi/client/series/search/tags.rb
+- lib/fredapi/client/series/tags.rb
+- lib/fredapi/client/series/updates.rb
+- lib/fredapi/client/series/vintage_dates.rb
+- lib/fredapi/client/source.rb
+- lib/fredapi/client/source/releases.rb
+- lib/fredapi/client/sources.rb
+- lib/fredapi/client/tags.rb
+- lib/fredapi/client/tags/series.rb
+- lib/fredapi/configuration.rb
+- lib/fredapi/connection.rb
+- lib/fredapi/request.rb
+- lib/fredapi/version.rb
+- spec/fredapi_spec.rb
+- spec/helper.rb
+homepage: https://github.com/jonathanchrisp/fredapi
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.2
+signing_key: 
+specification_version: 4
+summary: FRED API Ruby Wrapper
+test_files:
+- spec/fredapi_spec.rb
+- spec/helper.rb
+has_rdoc: