fredapi 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b5596e71170989d7088e8cc9ee61de17b24d889f
+  data.tar.gz: 8f1990935e85719290d9732d7831e705af4671b8
+SHA512:
+  metadata.gz: 91bc6fd387cea90b9a5c4f9c8d1439a269597cbd2b953fa7995af8486cc645f3559c49539d7be9b33b19e21855cfba0bd9d94d21cb22913a4c8f2ea549b7fd48
+  data.tar.gz: 328390e5b6fc6f80b038710a25ea2c8d31d00fe5774685226f848bc77311d08f0865cdd14ce28378638f1de505239447c7290fba0b34ac368ff72a8775d22472

data/.gitignore

@@ -0,0 +1,21 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+Gemfile.lock
+report.html
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 1.9.3
+  - 1.9.2
+
+before_script:
+  - chmod 600 spec/fixtures/.netrc
+
+script: bundle exec rspec spec

data/Gemfile

@@ -0,0 +1,6 @@
+source "http://rubygems.org"
+
+gem 'bundler', '~> 1.3.5'
+gem "coveralls", "~> 0.6.7", require: false
+
+gemspec

data/LICENCE.md

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Jonathan Chrisp
+
+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/bin/fredapi

@@ -0,0 +1,2 @@
+#!/usr/bin/env ruby
+require 'fredapi'

data/fredapi.gemspec

@@ -0,0 +1,26 @@
+require File.dirname(__FILE__) + "/lib/fredapi/version"
+
+Gem::Specification.new do |s|
+  s.name        = 'fredapi'
+  s.version     = FREDAPI::VERSION
+  s.date        = '2013-09-14'
+  s.summary     = 'FRED API Ruby Wrapper'
+  s.description = 'A Ruby wrapper for the FRED API'
+  s.author      = 'Jonathan Chrisp'
+  s.email       = 'jonathan.chrisp@gmail.com'
+  s.license     = 'MIT'
+  s.homepage    = 'https://github.com/jonathanchrisp/fredapi'
+  s.required_ruby_version = ">= 1.9.2"
+
+  s.add_development_dependency 'rspec', '~> 2.13.0'
+  s.add_development_dependency 'pry', '~> 0.9.12.2'
+
+  s.add_runtime_dependency 'faraday', '~> 0.8.7'
+  s.add_runtime_dependency 'faraday_middleware', '~> 0.9.0'
+  s.add_runtime_dependency 'hashie', '~> 2.0.5'
+
+  s.files         = `git ls-files`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.test_files    = `git ls-files -- spec/*`.split("\n")
+  s.require_paths = ['lib']
+end

data/lib/faraday/utils/utils.rb

@@ -0,0 +1,24 @@
+require 'faraday'
+
+# TODO: Remove this patch once latest faraday rc has been released
+# https://github.com/lostisland/faraday/issues/182#issuecomment-19518167
+module Faraday
+  # Overriding Faraday::Utils module build_nested_query method
+  module Utils
+    def build_nested_query(value, prefix = nil)
+      case value
+      when Array
+        value.map { |v| build_nested_query(v, "#{prefix}") }.join("&")
+      when Hash
+        value.map { |k, v|
+          build_nested_query(v, prefix ? "#{prefix}#{escape(k)}" : escape(k))
+        }.join("&")
+      when NilClass
+        prefix
+      else
+        raise ArgumentError, "value must be a Hash" if prefix.nil?
+        "#{prefix}=#{escape(value)}"
+      end
+    end
+  end
+end

data/lib/fredapi.rb

@@ -0,0 +1,29 @@
+require 'fredapi/version'
+require 'fredapi/configuration'
+require 'fredapi/client'
+
+# FREDAPI namespace module
+module FREDAPI
+  extend Configuration
+  class << self
+
+    # Alias for FREDAPI::Client.new
+    #
+    # @return [FREDAPI::Client]
+    def new opts={}
+      FREDAPI::Client.new opts
+    end
+
+    # Delegate to FREDAPI::Client.new
+    def method_missing method, *args, &block
+      return super unless new.respond_to? method
+      new.send method, *args, &block
+    end
+
+    # Check if method responds_to?
+    def respond_to? method, include_private=false
+      new.respond_to?(method, include_private) || super(method, include_private)
+    end
+
+  end
+end

data/lib/fredapi/client.rb

@@ -0,0 +1,41 @@
+require 'fredapi/connection'
+require 'fredapi/request'
+
+require 'fredapi/client/category'
+require 'fredapi/client/related_tags'
+require 'fredapi/client/release'
+require 'fredapi/client/releases'
+require 'fredapi/client/series'
+require 'fredapi/client/source'
+require 'fredapi/client/sources'
+require 'fredapi/client/tags'
+
+module FREDAPI
+  # Client class to create FREDAPI instances
+  class Client
+
+    attr_accessor *Configuration::OPTION_KEYS
+
+    def initialize opts={}
+      # Merge opts
+      opts = FREDAPI.options.merge opts
+
+      # Create instance variables
+      Configuration::OPTION_KEYS.each do |k|
+        send "#{k}=", opts[k]
+      end
+    end
+
+    include FREDAPI::Connection
+    include FREDAPI::Request
+
+    # API endpoints
+    include FREDAPI::Client::Category
+    include FREDAPI::Client::Release
+    include FREDAPI::Client::Releases
+    include FREDAPI::Client::Series
+    include FREDAPI::Client::Source
+    include FREDAPI::Client::Tags
+
+  end
+end

data/lib/fredapi/client/category.rb

@@ -0,0 +1,31 @@
+require 'fredapi/client/category/children'
+require 'fredapi/client/category/related'
+require 'fredapi/client/category/related_tags'
+require 'fredapi/client/category/series'
+require 'fredapi/client/category/tags'
+
+module FREDAPI
+  class Client
+    # Category module for fred/category endpoint
+    module Category
+
+      # Get a category
+      #
+      # @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] category_id The id for a category
+      # @return [Hashie::Mash] Hash containing the results
+      def category opts={}
+        get "fred/category", opts
+      end
+
+      include FREDAPI::Client::Category::Children
+      include FREDAPI::Client::Category::Related
+      include FREDAPI::Client::Category::RelatedTags
+      include FREDAPI::Client::Category::Series
+      include FREDAPI::Client::Category::Tags
+
+    end
+  end
+end

data/lib/fredapi/client/category/children.rb

@@ -0,0 +1,23 @@
+module FREDAPI
+  class Client
+    module Category
+      # Category module for fred/category/children endpoint
+      module Children
+
+        # Get the child categories for a specified parent category
+        #
+        # @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] category_id The id for a category
+        # @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 category_children opts={}
+          get "fred/category/children", opts
+        end
+
+      end
+    end
+  end
+end

data/lib/fredapi/client/category/related.rb

@@ -0,0 +1,23 @@
+module FREDAPI
+  class Client
+    module Category
+      # Related module for fred/category/related endpoint
+      module Related
+
+        # Get the related categories for a category
+        #
+        # @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] category_id The id for a category
+        # @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 category_related opts={}
+          get "fred/category/related", opts
+        end
+
+      end
+    end
+  end
+end

data/lib/fredapi/client/category/related_tags.rb

@@ -0,0 +1,30 @@
+module FREDAPI
+  class Client
+    module Category
+      # RelatedTags module for fred/category/related_tags endpoint
+      module RelatedTags
+
+        # Get the related tags for a category
+        #
+        # @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] category_id The id for a category
+        # @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_names A semicolon delimited list of tags to find related tags for
+        # @option opts [String] tag_group_id A tag group id to filter tags by type
+        # @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 category_related_tags opts={}
+          get "fred/category/related_tags", opts
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+module FREDAPI
+  class Client
+    module Category
+      # Series module for fred/category/series endpoint
+      module Series
+
+        # Get the series in a category
+        #
+        # @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] category_id The id for a category
+        # @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
+        # @option opts [String] filter_variable The attribute to filter results by
+        # @option opts [String] filter_value The attribute to filter results by
+        # @option opts [String] tag_names A semicolon delimited list of tags to find related tags for
+        # @return [Hashie::Mash] Hash containing the results
+        def category_series opts={}
+          get "fred/category/series", opts
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+module FREDAPI
+  class Client
+    module Category
+      # Tags module for fred/category/tags endpoint
+      module Tags
+
+        # Get the tags for a category
+        #
+        # @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] category_id The id for a category
+        # @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 category_tags opts={}
+          get "fred/category/tags", opts
+        end
+
+      end
+    end
+  end
+end

data/lib/fredapi/client/related_tags.rb

@@ -0,0 +1,27 @@
+module FREDAPI
+  class Client
+    # RelatedTags module for fred/related_tags endpoint
+    module RelatedTags
+
+      # Get the related tags for one or more 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 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 related_tags opts={}
+        get "fred/related_tags", opts
+      end
+
+    end
+  end
+end

data/lib/fredapi/client/release.rb

@@ -0,0 +1,33 @@
+require 'fredapi/client/release/dates'
+require 'fredapi/client/release/series'
+require 'fredapi/client/release/sources'
+require 'fredapi/client/release/tags'
+require 'fredapi/client/release/related_tags'
+
+module FREDAPI
+  class Client
+    # Release module for fred/release endpoint
+    module Release
+
+      # Get a release 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] release_id The id for a release
+      # @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 release opts={}
+        get "fred/release", opts
+      end
+
+      include FREDAPI::Client::Release::Dates
+      include FREDAPI::Client::Release::Series
+      include FREDAPI::Client::Release::Sources
+      include FREDAPI::Client::Release::Tags
+      include FREDAPI::Client::Release::RelatedTags
+
+    end
+  end
+end

data/lib/fredapi/client/release/dates.rb

@@ -0,0 +1,28 @@
+module FREDAPI
+  class Client
+    module Release
+      # Dates module for fred/release/dates endpoint
+      module Dates
+
+        # Get release dates for all releases 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] release_id The id for a release
+        # @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
+        # @option opts [Integer] include_release_dates_with_no_data Determines whether release dates with no data available are returned.
+        # @return [Hashie::Mash] Hash containing the results
+        def release_dates opts={}
+          get "fred/release/dates", opts
+        end
+
+      end
+    end
+  end
+end