ffiec 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e2622ad8498a364eddc77be1f7b2cc0ed151fa9d
+  data.tar.gz: 51f827d83fbf4f96134b01d317af2c486de30351
+SHA512:
+  metadata.gz: 6e0531b7990b124eb38648af805daaff1576787e970c54ac1a31fd265c828e8154eea83dff5f68448a291b4390b789a6daeb3ab16eba1cec75337ea30a71e83f
+  data.tar.gz: a652c461c56910912711eeed5681e11ce02610e95c6df4e1fc0e49bcf50130a9f0728235b45973bd7f7a87f48f452c475b4a0bb7e3e6fbc99a68fed9bf3b201c

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/*.gem

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.10.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ffiec.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Andrew Curley
+
+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,45 @@
+# Ffiec
+
+This gem is a Ruby wrapper for the FFIEC (Federal Financial Institutions Examination Council) Public Data Distribution (PDD) Public Web Service (PWS). Before using this gem you must sign up for a web services account at the [FFIEC's website](https://cdr.ffiec.gov/public/PWS/CreateAccount.aspx) where you will choose a username and be provided with an API key.
+
+* [Documentation for the SOAP API](https://cdr.ffiec.gov/Public/PWS/WebServices/RetrievalService.asmx)
+* [WSDL file](https://cdr.ffiec.gov/Public/PWS/WebServices/RetrievalService.asmx?WSDL)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ffiec'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ffiec
+
+## Usage
+```
+client = Ffiec::Client.new(username:'your_username', api_key:'your_api_key')
+
+client.available_commands
+=> [:test_user_access, :retrieve_reporting_periods, :retrieve_panel_of_reporters, :retrieve_filers_submission_date_time, :retrieve_filers_since_date, :retrieve_facsimile, :retrieve_ubpr_reporting_periods, :retrieve_ubprxbrl_facsimile]
+
+client.test_user_access
+=> true
+
+client.retrieve_facsimile(date: '9/30/2015', format: 'SDF', id: 37, id_type: 'ID_RSSD')
+=> "Call Date;Bank RSSD Identifier;MDRM #;Value;Last Update;Short Definition;Call Schedule;Line Number\r\n20150930;37;RCOA3792;20326;20151028;Total capital (sum of items 26 and 34.a)..."
+```
+
+## Development
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+Bug reports and pull requests are welcome on GitHub at https://github.com/acurley/ffiec. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ffiec"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/ffiec.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ffiec/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ffiec"
+  spec.version       = Ffiec::VERSION
+  spec.authors       = ["Andrew Curley"]
+  spec.email         = ["andrew.curley@gmail.com"]
+
+  spec.summary       = "Ruby wrapper around the FFIEC's Public Data Distribution (PDD) Public Web Service (PWS)"
+  spec.description   = "The FFIEC (Federal Financial Institutions Examination Council) provides a SOAP web service for it's Public Data Distribution (PDD) Public Web Service (PWS).  Through this API you can obtain financial and structural information for most FDIC-insured institutions. The information available on this site is updated to reflect the most recent data for both prior and current periods. "
+  spec.homepage      = "http://github.com/acurley/ffiec"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_dependency "savon"
+end

data/lib/ffiec.rb

@@ -0,0 +1,7 @@
+require "ffiec/version"
+require 'ffiec/client'
+require "savon"
+
+module Ffiec
+  # Your code goes here...
+end

data/lib/ffiec/client.rb

@@ -0,0 +1,55 @@
+require 'savon'
+
+module Ffiec
+  class Client
+   
+    # Return new Ffiec::Client, which is really a wrapper around Savon::Client 
+    def initialize(username:, api_key:)
+      wsdl_endpoint = "https://cdr.ffiec.gov/Public/PWS/WebServices/RetrievalService.asmx?WSDL"
+      @client = Savon.client(wsdl: wsdl_endpoint, wsse_auth: [username, api_key])
+    end
+
+    # Return array of commands that the WDL endpoint prescribes
+    def available_commands
+      return @client.operations
+    end
+
+    # Return array of strings that contain dates for which reports are available
+    def retrieve_reporting_periods
+      response = @client.call(:retrieve_reporting_periods)
+      return response.body[:retrieve_reporting_periods_response][:retrieve_reporting_periods_result][:string]
+    end
+
+    def retrieve_panel_of_reporters
+    end
+
+    def retrieve_filers_submission_date_time
+    end
+
+    def retrieve_filers_since_date
+    end
+
+    # Returns the web service response already decoded using Base64.decode64. The output is ready to be written to a file or processed inline. Accepted valued for parameters are:
+    # 
+    # date - (See output of :retrieve_reporting_periods method for acceptable values)
+    # format - Acceptable values: PDF, SDF (semicolon delimited format) and XBRL
+    # id_type - Acceptable values: FDICCertNumber, ID_RSSD, OCCChartNumber and OTSDockNumber
+    # id - The financial institution's ID based on the enumerated fiIDType
+    def retrieve_facsimile(date:, format:, id:, id_type:)
+      response = @client.call(:retrieve_facsimile, message: {reportingPeriodEndDate: date, fiID: id, facsimileFormat: format, fiIDType: id_type})
+      return Base64.decode64 response.body[:retrieve_facsimile_response][:retrieve_facsimile_result]
+    end
+
+    def retrieve_ubpr_reporting_periods
+    end
+
+    def retrieve_ubprxbrl_facsimile
+    end
+
+    # Returns boolean response stating whether a user has provided valid credentials
+    def test_user_access
+      response = @client.call(:test_user_access)
+      return response.body[:test_user_access_response][:test_user_access_result]
+    end
+  end
+end

data/lib/ffiec/version.rb

@@ -0,0 +1,3 @@
+module Ffiec
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: ffiec
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Andrew Curley
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-11-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: savon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 'The FFIEC (Federal Financial Institutions Examination Council) provides
+  a SOAP web service for it''s Public Data Distribution (PDD) Public Web Service (PWS).  Through
+  this API you can obtain financial and structural information for most FDIC-insured
+  institutions. The information available on this site is updated to reflect the most
+  recent data for both prior and current periods. '
+email:
+- andrew.curley@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- ffiec.gemspec
+- lib/ffiec.rb
+- lib/ffiec/client.rb
+- lib/ffiec/version.rb
+homepage: http://github.com/acurley/ffiec
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Ruby wrapper around the FFIEC's Public Data Distribution (PDD) Public Web
+  Service (PWS)
+test_files: []