fred 0.1.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 [name of plugin creator]
+
+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/README.md

@@ -0,0 +1,40 @@
+# Fred
+
+This is a Ruby wrapper for the St. Louis Federal Reserve Economic Data [Fred API](http://api.stlouisfed.org/).
+
+## Installation
+
+In your Rails directory:
+
+    script/plugin install git://github.com/phuphighter/fred.git
+    
+## Get a FRED API key
+
+Sign up for a Fred API key: [http://api.stlouisfed.org/api_key.html](http://api.stlouisfed.org/api_key.html)
+    
+## Usage
+
+### Instantiate a client
+
+    >> fred = Fred::Client.new(:api_key => 'your_api_key')
+    
+### or configure once
+
+    >> Fred.configure do |config|
+    >>   config.api_key = 'your_api_key'
+    >> end
+    >> fred = Fred::Client.new
+    
+#### Examples
+
+    >> fred.category(nil, :category_id => '125')
+    => {"categories"=>{"category"=>{"name"=>"Trade Balance", "id"=>"125", "parent_id"=>"13"}}}
+    
+    >> fred.series("categories", :series_id => 'EXJPUS')
+    => {"categories"=>{"category"=>[{"name"=>"Monthly Rates", "id"=>"95", "parent_id"=>"15"}, {"name"=>"Japan", "id"=>"275", "parent_id"=>"158"}]}}
+
+## Copyright
+
+Contact me if you have any suggestions and feel free to fork it!
+
+Copyright (c) 2009 Johnny Khai Nguyen, released under the MIT license

data/Rakefile

@@ -0,0 +1,41 @@
+require 'rubygems'
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "fred"
+    gem.summary = %Q{Ruby wrapper for the St. Louis Federal Reserve FRED API}
+    gem.description = %Q{Ruby wrapper for the St. Louis Federal Reserve FRED API}
+    gem.email = "johnnyn@gmail.com"
+    gem.homepage = "http://github.com/phuphighter/fred"
+    gem.authors = ["Johnny Khai Nguyen"]
+    
+    gem.add_dependency('httparty', '>= 0.5.0')
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the fred plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the fred plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Fred'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/generators/fred/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Explain the generator
+
+Example:
+    ./script/generate fred Thing
+
+    This will create:
+        what/will/it/create

data/generators/fred/fred_generator.rb

@@ -0,0 +1,8 @@
+class FredGenerator < Rails::Generator::NamedBase
+  def manifest
+    record do |m|
+      # m.directory "lib"
+      # m.template 'README', "README"
+    end
+  end
+end

data/init.rb

@@ -0,0 +1 @@
+# Include hook code here

data/install.rb

@@ -0,0 +1 @@
+# Install hook code here

data/lib/fred.rb

@@ -0,0 +1,36 @@
+# Fred
+require 'rubygems'
+gem 'httparty'
+require 'httparty'
+
+directory = File.expand_path(File.dirname(__FILE__))
+
+module Fred
+  
+  # create config/initializers/fred.rb
+  # 
+  # Fred.configure do |config|
+  #   config.api_key = 'api_key'
+  # end
+  # client = Fred::Client.new
+  #
+  # or
+  #
+  # Fred.api_key = 'api_key'
+  #
+  # or
+  #
+  # Fred::Client.new(:api_key => 'api_key')
+  
+  def self.configure
+    yield self
+    true
+  end
+
+  class << self
+    attr_accessor :api_key
+  end
+  
+end
+
+require File.join(directory, 'fred', 'client')

data/lib/fred/client.rb

@@ -0,0 +1,68 @@
+module Fred
+  
+  class Client
+    include HTTParty
+    base_uri "http://api.stlouisfed.org/fred"
+        
+    attr_reader :api_key
+                
+    def initialize(options={})
+      @api_key = options[:api_key] || Fred.api_key
+    end
+
+    def category(secondary, options={})
+      if secondary.nil?
+        response = self.class.get("/category", :query => options.merge(self.default_options))
+      else
+        response = self.class.get("/category/#{secondary}", :query => options.merge(self.default_options))			
+      end
+    end
+    
+    def releases(secondary, options={})
+      if secondary.nil?
+        response = self.class.get("/releases", :query => options.merge(self.default_options))
+      else
+        response = self.class.get("/releases/#{secondary}", :query => options.merge(self.default_options))			
+      end
+    end
+    
+    def release(secondary, options={})
+      if secondary.nil?
+        response = self.class.get("/release", :query => options.merge(self.default_options))
+      else
+        response = self.class.get("/release/#{secondary}", :query => options.merge(self.default_options))			
+      end
+    end
+    
+    def series(secondary, options={})
+      if secondary.nil?
+        response = self.class.get("/series", :query => options.merge(self.default_options))
+      else
+        response = self.class.get("/series/#{secondary}", :query => options.merge(self.default_options))			
+      end
+    end
+    
+    def sources(secondary, options={})
+      if secondary.nil?
+        response = self.class.get("/sources?", :query => options.merge(self.default_options))
+      else
+        response = self.class.get("/sources/#{secondary}", :query => options.merge(self.default_options))			
+      end
+    end
+    
+    def source(secondary, options={})
+      if secondary.nil?
+        response = self.class.get("/source", :query => options.merge(self.default_options))
+      else
+        response = self.class.get("/source/#{secondary}", :query => options.merge(self.default_options))			
+      end
+    end
+    
+    protected
+    
+    def default_options
+      {:api_key => @api_key}
+    end
+
+  end
+end

data/tasks/fred_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :fred do
+#   # Task goes here
+# end

data/test/fred_test.rb

@@ -0,0 +1,8 @@
+require 'test_helper'
+
+class FredTest < ActiveSupport::TestCase
+  # Replace this with your real tests.
+  test "the truth" do
+    assert true
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'rubygems'
+require 'active_support'
+require 'active_support/test_case'

data/uninstall.rb

@@ -0,0 +1 @@
+# Uninstall hook code here

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification 
+name: fred
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Johnny Khai Nguyen
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-05-16 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: httparty
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 5
+        - 0
+        version: 0.5.0
+  type: :runtime
+  version_requirements: *id001
+description: Ruby wrapper for the St. Louis Federal Reserve FRED API
+email: johnnyn@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.md
+files: 
+- MIT-LICENSE
+- README.md
+- Rakefile
+- VERSION
+- generators/fred/USAGE
+- generators/fred/fred_generator.rb
+- init.rb
+- install.rb
+- lib/fred.rb
+- lib/fred/client.rb
+- tasks/fred_tasks.rake
+- test/fred_test.rb
+- test/test_helper.rb
+- uninstall.rb
+has_rdoc: true
+homepage: http://github.com/phuphighter/fred
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Ruby wrapper for the St. Louis Federal Reserve FRED API
+test_files: 
+- test/fred_test.rb
+- test/test_helper.rb