fredapi 1.0.0 → 1.0.1.pre.6

checksums.yaml

@@ -1,7 +1,15 @@
 ---
-SHA1:
-  metadata.gz: b5596e71170989d7088e8cc9ee61de17b24d889f
-  data.tar.gz: 8f1990935e85719290d9732d7831e705af4671b8
-SHA512:
-  metadata.gz: 91bc6fd387cea90b9a5c4f9c8d1439a269597cbd2b953fa7995af8486cc645f3559c49539d7be9b33b19e21855cfba0bd9d94d21cb22913a4c8f2ea549b7fd48
-  data.tar.gz: 328390e5b6fc6f80b038710a25ea2c8d31d00fe5774685226f848bc77311d08f0865cdd14ce28378638f1de505239447c7290fba0b34ac368ff72a8775d22472
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NzhhYzcyYzg1OWUxOTA2YWVhZWU0ODkxNWYzZDk2ODg4MGY2MGFmOA==
+  data.tar.gz: !binary |-
+    MWQ5YjExOTg0MjE4YzJlMjI2Y2VhNDY3NDIxN2JiNzE2NzA4ZTRlNg==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    YmNhNmE4MGE1MjM5ODk5YTc4M2UyYmZjMzBhZjU0NjNmYTc5NTA1YTI0ZmU0
+    MmJkYzkyZGE2YzJlNjlmNTFlYzMxNjZhYTczZGMxYjY0OTc5YzAyODZhZjkz
+    OWJmNmI3MTdmMjc1N2NlNjRhOWIzZmFiZmMwY2NhOWEwYTYxZTU=
+  data.tar.gz: !binary |-
+    YjVhNmFkZjk4ZTM4M2I2MTIxYzQ0NjY2YjE2M2M4YjVhMjg4NTJlMTAxNDA2
+    Y2Y4MDliODM0NDdkMWE2MTBjNWE2MDM2MDQzODBkZjhjZGFmNWM3MmY5ZGY4
+    MjMxMjMxZWRkMGE3NjVhN2MxZTcwNmFmNGE2YzRkMDczN2Q3MWI=

data/.travis.yml

@@ -1,10 +1,15 @@
 language: ruby
 rvm:
-  - 2.0.0
-  - 1.9.3
-  - 1.9.2
+- 2.0.0
+- 1.9.3
+- 1.9.2
 
-before_script:
-  - chmod 600 spec/fixtures/.netrc
+deploy:
+  provider: rubygems
+  api_key:
+    secure: Sp/4Xrahu59AP1NFDdf3vsfpdoH0NzG9HtUdkwCVprfvBArHXwNcQi5b2i1m14q6M+njCtwmOg/OlqAoInsFf6QQXm9PZGjM/KZTpAw/YQ6+qmYDKXBpcMuYB/3HltBm4TJQ3y1enXPlOxqvI1NO2vcq31KwHn7XV8UvbTS/sfw=
+  gem: fredapi
+  on:
+    repo: jonathanchrisp/fredapi
 
-script: bundle exec rspec spec
+script: bundle exec rspec

data/Gemfile

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

data/README.md

@@ -0,0 +1,75 @@
+[![Gem Version](https://badge.fury.io/rb/fredapi.png)](http://badge.fury.io/rb/fredapi)
+[![Build Status](https://travis-ci.org/jonathanchrisp/fredapi.png?branch=master)](https://travis-ci.org/jonathanchrisp/fredapi)
+[![Dependency Status](https://gemnasium.com/jonathanchrisp/fredapi.png)](https://gemnasium.com/jonathanchrisp/fredapi)
+[![Code Climate](https://codeclimate.com/github/jonathanchrisp/fredapi.png)](https://codeclimate.com/github/jonathanchrisp/fredapi)
+[![Coverage Status](https://coveralls.io/repos/jonathanchrisp/fredapi/badge.png)](https://coveralls.io/r/jonathanchrisp/fredapi)
+
+# fredapi
+A Ruby wrapper for the [Federal Reserve Economic Data API](http://api.stlouisfed.org/docs/fred/overview.html) (FRED).
+
+## Documentation
+* Original documenation: <http://api.stlouisfed.org/docs/fred/>
+* Gem documentation: <http://rubydoc.info/gems/fredapi>
+
+## Getting Started
+In order to be able to send API requests you'll first need to install the `fredapi` gem.
+
+```ruby
+gem install fredapi
+```
+
+You will need to register and request an API key in order to requests. To register please click [here](http://research.stlouisfed.org/useraccount/register/step1). Request an API key by following the instructions [here](http://api.stlouisfed.org/api_key.html).
+
+Once you have completed the steps above, you can now create an instance of a `FREDAPI::Client` and set your API key as appropriate:
+
+```ruby
+require 'fredapi'
+api = FREDAPI::Client.new 'api_key' => '123456789'
+```
+
+If you now look at your `FREDAPI` object instance it will be similar to the following:
+
+```ruby
+<FREDAPI::Client:0x007ffb89bcf3e0
+@adapter=:net_http,
+@api_endpoint="http://api.stlouisfed.org/",
+@api_key='123456789',
+@file_type="json",
+@user_agent="FREDAPI Ruby Gem 1.0.0">
+```
+
+By the default the file_type is set to `json`. This can be easily be changed by simply updating the instance variable to be set to `xml`:
+
+```ruby
+api.file_type = 'xml'
+```
+
+Please note that when sending any FRED API request if you don't pass an `api_key` or `file_type` parameter the values on the `FREDAPI::Client` instance will be used as default.
+
+## Example requests
+Now that you have an `FREDAPI::Client` instance with your API key you can now make requests to the FRED API. For example to send a category get request do the following:
+
+```ruby
+api.category 'category_id' => 125
+```
+
+The response is returned within a `Hashie::Mash` instance.
+
+```ruby
+{"categories"=>[{"id"=>125, "name"=>"Trade Balance", "parent_id"=>13}]}
+```
+
+To find out more information about `Hashie` please visit the following link: <https://github.com/intridea/hashie>. To see all documention on the various FREDAPI endpoint method calls please visit: <http://rubydoc.info/gems/fredapi>
+
+## Tests
+There are a number of unit tests which are included as part of this project, please run:
+
+```ruby
+rspec spec
+```
+
+Please note that a number of tests still need to be added so I don't currently have complete coverage, subject to workload these will be slowly added over the next few months.
+
+## Feedback
+I would be more than happy to recieve feedback, please email me at: jonathan.chrisp@gmail.com.
+

data/fredapi.gemspec

@@ -3,7 +3,8 @@ 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.version     = FREDAPI::VERSION + ".pre.#{ENV['TRAVIS_BUILD_NUMBER']}" if ENV['TRAVIS']
+  s.date        = '2013-09-20'
   s.summary     = 'FRED API Ruby Wrapper'
   s.description = 'A Ruby wrapper for the FRED API'
   s.author      = 'Jonathan Chrisp'
@@ -13,7 +14,6 @@ Gem::Specification.new do |s|
   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'

data/lib/fredapi/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fredapi
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1.pre.6
 platform: ruby
 authors:
 - Jonathan Chrisp
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-14 00:00:00.000000000 Z
+date: 2013-09-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -24,20 +24,6 @@ dependencies:
     - - ~>
       - !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
@@ -143,21 +129,20 @@ 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'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.2
+rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
 summary: FRED API Ruby Wrapper
 test_files:
 - spec/fredapi_spec.rb
 - spec/helper.rb
-has_rdoc: