vericred_client 0.0.1

data/spec/api/zip_counties_api_spec.rb

@@ -0,0 +1,171 @@
+=begin
+Vericred API
+
+Vericred's API allows you to search for Health Plans that a specific doctor
+accepts.
+
+## Getting Started
+
+Visit our [Developer Portal](https://vericred.3scale.net/access_code?access_code=vericred&cms_token=3545ca52af07bde85b7c0c3aa9d1985e) to
+create an account.
+
+Once you have created an account, you can create one Application for
+Production and another for our Sandbox (select the appropriate Plan when
+you create the Application).
+
+## Authentication
+
+To authenticate, pass the API Key you created in the Developer Portal as
+a `Vericred-Api-Key` header.
+
+`curl -H 'Vericred-Api-Key: YOUR_KEY' "https://api.vericred.com/providers?search_term=Foo&zip_code=11215"`
+
+## Versioning
+
+Vericred's API default to the latest version.  However, if you need a specific
+version, you can request it with an `Accept-Version` header.
+
+The current version is `v3`.  Previous versions are `v1` and `v2`.
+
+`curl -H 'Vericred-Api-Key: YOUR_KEY' -H 'Accept-Version: v2' "https://api.vericred.com/providers?search_term=Foo&zip_code=11215"`
+
+## Pagination
+
+Most endpoints are not paginated.  It will be noted in the documentation if/when
+an endpoint is paginated.
+
+When pagination is present, a `meta` stanza will be present in the response
+with the total number of records
+
+```
+{
+  things: [{ id: 1 }, { id: 2 }],
+  meta: { total: 500 }
+}
+```
+
+## Sideloading
+
+When we return multiple levels of an object graph (e.g. `Provider`s and their `State`s
+we sideload the associated data.  In this example, we would provide an Array of
+`State`s and a `state_id` for each provider.  This is done primarily to reduce the
+payload size since many of the `Provider`s will share a `State`
+
+```
+{
+  providers: [{ id: 1, state_id: 1}, { id: 2, state_id: 1 }],
+  states: [{ id: 1, code: 'NY' }]
+}
+```
+
+If you need the second level of the object graph, you can just match the
+corresponding id.
+
+## Selecting specific data
+
+All endpoints allow you to specify which fields you would like to return.
+This allows you to limit the response to contain only the data you need.
+
+For example, let's take a request that returns the following JSON by default
+
+```
+{
+  provider: {
+    id: 1,
+    name: 'John',
+    phone: '1234567890',
+    field_we_dont_care_about: 'value_we_dont_care_about'
+  },
+  states: [{
+    id: 1,
+    name: 'New York',
+    code: 'NY',
+    field_we_dont_care_about: 'value_we_dont_care_about'
+  }]
+}
+```
+
+To limit our results to only return the fields we care about, we specify the
+`select` query string parameter for the corresponding fields in the JSON
+document.
+
+In this case, we want to select `name` and `phone` from the `provider` key,
+so we would add the parameters `select=provider.name,provider.phone`.
+We also want the `name` and `code` from the `states` key, so we would
+add the parameters `select=states.name,staes.code`.  The id field of
+each document is always returned whether or not it is requested.
+
+Our final request would be `GET /providers/12345?select=provider.name,provider.phone,states.name,states.code`
+
+The response would be
+
+```
+{
+  provider: {
+    id: 1,
+    name: 'John',
+    phone: '1234567890'
+  },
+  states: [{
+    id: 1,
+    name: 'New York',
+    code: 'NY'
+  }]
+}
+```
+
+
+
+OpenAPI spec version: 
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for VericredClient::ZipCountiesApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'ZipCountiesApi' do
+  before do
+    # run before each test
+    @instance = VericredClient::ZipCountiesApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of ZipCountiesApi' do
+    it 'should create an instact of ZipCountiesApi' do
+      @instance.should be_a(VericredClient::ZipCountiesApi)
+    end
+  end
+
+  # unit tests for zip_counties_get
+  # Find Zip Counties by Zip Code
+  # ### Finding Zip Code and Fips Code
+
+Our `Plan` endpoints require a zip code and a fips (county) code.  This is
+because plan pricing requires both of these elements.  Users are unlikely to
+know their fips code, so we provide this endpoint to look up a `ZipCounty` by
+zip code and return both the selected zip and fips codes.
+
+
+  # @param zip_prefix Partial five-digit Zip
+  # @param [Hash] opts the optional parameters
+  # @return [InlineResponse2002]
+  describe 'zip_counties_get test' do
+    it "should work" do
+      # assertion here
+      # should be_a()
+      # should be_nil
+      # should ==
+      # should_not ==
+    end
+  end
+
+end

data/vericred_client.gemspec

@@ -0,0 +1,31 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "vericred_client/version"
+
+Gem::Specification.new do |s|
+  s.name        = "vericred_client"
+  s.version     = VericredClient::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Vericred Inc."]
+  s.email       = ["developers@vericred.com"]
+  s.homepage    = "https://github.com/vericred_client"
+  s.summary     = "Vericred API Ruby Gem"
+  s.description = "Autogenerated Ruby client for the Vericred API"
+  s.license     = "MIT"
+
+  s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
+  s.add_runtime_dependency 'json', '~> 1.8', '>= 1.8.3'
+
+  s.add_development_dependency 'rspec', '~> 3.4', '>= 3.4.0'
+  s.add_development_dependency 'vcr', '~> 3.0', '>= 3.0.1'
+  s.add_development_dependency 'webmock', '~> 1.24', '>= 1.24.3'
+  s.add_development_dependency 'autotest', '~> 4.4', '>= 4.4.6'
+  s.add_development_dependency 'autotest-rails-pure', '~> 4.1', '>= 4.1.2'
+  s.add_development_dependency 'autotest-growl', '~> 0.2', '>= 0.2.16'
+  s.add_development_dependency 'autotest-fsevent', '~> 0.2', '>= 0.2.11'
+
+  s.files         = `find *`.split("\n").uniq.sort.select{|f| !f.empty? }
+  s.test_files    = `find spec/*`.split("\n")
+  s.executables   = []
+  s.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,285 @@
+--- !ruby/object:Gem::Specification
+name: vericred_client
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Vericred Inc.
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-04-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.1
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.24'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.24.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.24'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.24.3
+- !ruby/object:Gem::Dependency
+  name: autotest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.4.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.4.6
+- !ruby/object:Gem::Dependency
+  name: autotest-rails-pure
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.1.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.1.2
+- !ruby/object:Gem::Dependency
+  name: autotest-growl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.16
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.16
+- !ruby/object:Gem::Dependency
+  name: autotest-fsevent
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.11
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.11
+description: Autogenerated Ruby client for the Vericred API
+email:
+- developers@vericred.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- docs/Applicant.md
+- docs/Carrier.md
+- docs/CarrierSubsidiary.md
+- docs/County.md
+- docs/Drug.md
+- docs/DrugCoverage.md
+- docs/DrugCoverageApi.md
+- docs/InlineResponse200.md
+- docs/InlineResponse2001.md
+- docs/InlineResponse2002.md
+- docs/Plan.md
+- docs/PlanCounty.md
+- docs/PlanSearchResult.md
+- docs/PlansApi.md
+- docs/Pricing.md
+- docs/Provider.md
+- docs/ProvidersApi.md
+- docs/Query.md
+- docs/RatingArea.md
+- docs/State.md
+- docs/ZipCode.md
+- docs/ZipCountiesApi.md
+- docs/ZipCounty.md
+- lib/vericred_client.rb
+- lib/vericred_client/api/drug_coverage_api.rb
+- lib/vericred_client/api/plans_api.rb
+- lib/vericred_client/api/providers_api.rb
+- lib/vericred_client/api/zip_counties_api.rb
+- lib/vericred_client/api_client.rb
+- lib/vericred_client/api_error.rb
+- lib/vericred_client/configuration.rb
+- lib/vericred_client/models/applicant.rb
+- lib/vericred_client/models/carrier.rb
+- lib/vericred_client/models/carrier_subsidiary.rb
+- lib/vericred_client/models/county.rb
+- lib/vericred_client/models/drug.rb
+- lib/vericred_client/models/drug_coverage.rb
+- lib/vericred_client/models/inline_response_200.rb
+- lib/vericred_client/models/inline_response_200_1.rb
+- lib/vericred_client/models/inline_response_200_2.rb
+- lib/vericred_client/models/plan.rb
+- lib/vericred_client/models/plan_county.rb
+- lib/vericred_client/models/plan_search_result.rb
+- lib/vericred_client/models/pricing.rb
+- lib/vericred_client/models/provider.rb
+- lib/vericred_client/models/query.rb
+- lib/vericred_client/models/rating_area.rb
+- lib/vericred_client/models/state.rb
+- lib/vericred_client/models/zip_code.rb
+- lib/vericred_client/models/zip_county.rb
+- lib/vericred_client/version.rb
+- spec/api/drug_coverage_api_spec.rb
+- spec/api/plans_api_spec.rb
+- spec/api/providers_api_spec.rb
+- spec/api/zip_counties_api_spec.rb
+- vericred_client.gemspec
+homepage: https://github.com/vericred_client
+licenses:
+- MIT
+metadata: {}
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Vericred API Ruby Gem
+test_files:
+- spec/api/drug_coverage_api_spec.rb
+- spec/api/plans_api_spec.rb
+- spec/api/providers_api_spec.rb
+- spec/api/zip_counties_api_spec.rb