vericred_client 0.0.7 → 0.0.8

data/spec/api/providers_api_spec.rb

@@ -1,7 +1,7 @@
 =begin
-Vericred API
+#Vericred API
 
-Vericred's API allows you to search for Health Plans that a specific doctor
+#Vericred's API allows you to search for Health Plans that a specific doctor
 accepts.
 
 ## Getting Started
@@ -37,7 +37,6 @@ namely `Total`, `Per-Page`, `Link`, and `Page` as described in [RFC-5988](https:
 
 For example, to display 5 results per page and view the second page of a
 `GET` to `/networks`, your final request would be `GET /networks?....page=2&per_page=5`.
-```
 
 ## Sideloading
 
@@ -115,6 +114,17 @@ OpenAPI spec version: 1.0.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
 
 =end
 
@@ -136,7 +146,7 @@ describe 'ProvidersApi' do
 
   describe 'test an instance of ProvidersApi' do
     it 'should create an instact of ProvidersApi' do
-      @instance.should be_a(VericredClient::ProvidersApi)
+      expect(@instance).to be_instance_of(VericredClient::ProvidersApi)
     end
   end
 
@@ -148,40 +158,19 @@ describe 'ProvidersApi' do
   # @return [ProviderShowResponse]
   describe 'get_provider test' do
     it "should work" do
-      # assertion here
-      # should be_a()
-      # should be_nil
-      # should ==
-      # should_not ==
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
 
   # unit tests for get_providers
   # Find Providers
-  # All `Provider` searches require a `zip_code`, which we use for weighting
-the search results to favor `Provider`s that are near the user.  For example,
-we would want "Dr. John Smith" who is 5 miles away to appear before
-"Dr. John Smith" who is 100 miles away.
-
-The weighting also allows for non-exact matches.  In our prior example, we
-would want "Dr. Jon Smith" who is 2 miles away to appear before the exact
-match "Dr. John Smith" who is 100 miles away because it is more likely that
-the user just entered an incorrect name.
-
-The free text search also supports Specialty name search and "body part"
-Specialty name search.  So, searching "John Smith nose" would return
-"Dr. John Smith", the ENT Specialist before "Dr. John Smith" the Internist.
-
+  # All `Provider` searches require a `zip_code`, which we use for weighting the search results to favor `Provider`s that are near the user.  For example, we would want \"Dr. John Smith\" who is 5 miles away to appear before \"Dr. John Smith\" who is 100 miles away.  The weighting also allows for non-exact matches.  In our prior example, we would want \"Dr. Jon Smith\" who is 2 miles away to appear before the exact match \"Dr. John Smith\" who is 100 miles away because it is more likely that the user just entered an incorrect name.  The free text search also supports Specialty name search and \"body part\" Specialty name search.  So, searching \"John Smith nose\" would return \"Dr. John Smith\", the ENT Specialist before \"Dr. John Smith\" the Internist. 
   # @param [Hash] opts the optional parameters
   # @option opts [RequestProvidersSearch] :body 
   # @return [ProvidersSearchResponse]
   describe 'get_providers test' do
     it "should work" do
-      # assertion here
-      # should be_a()
-      # should be_nil
-      # should ==
-      # should_not ==
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
 

data/spec/api/zip_counties_api_spec.rb

@@ -1,7 +1,7 @@
 =begin
-Vericred API
+#Vericred API
 
-Vericred's API allows you to search for Health Plans that a specific doctor
+#Vericred's API allows you to search for Health Plans that a specific doctor
 accepts.
 
 ## Getting Started
@@ -37,7 +37,6 @@ namely `Total`, `Per-Page`, `Link`, and `Page` as described in [RFC-5988](https:
 
 For example, to display 5 results per page and view the second page of a
 `GET` to `/networks`, your final request would be `GET /networks?....page=2&per_page=5`.
-```
 
 ## Sideloading
 
@@ -115,6 +114,17 @@ OpenAPI spec version: 1.0.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
 
 =end
 
@@ -136,7 +146,7 @@ describe 'ZipCountiesApi' do
 
   describe 'test an instance of ZipCountiesApi' do
     it 'should create an instact of ZipCountiesApi' do
-      @instance.should be_a(VericredClient::ZipCountiesApi)
+      expect(@instance).to be_instance_of(VericredClient::ZipCountiesApi)
     end
   end
 
@@ -148,11 +158,7 @@ describe 'ZipCountiesApi' do
   # @return [ZipCountyResponse]
   describe 'get_zip_counties test' do
     it "should work" do
-      # assertion here
-      # should be_a()
-      # should be_nil
-      # should ==
-      # should_not ==
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
 

data/spec/api_client_spec.rb

@@ -0,0 +1,403 @@
+=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) 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
+
+Endpoints that accept `page` and `per_page` parameters are paginated. They expose
+four additional fields that contain data about your position in the response,
+namely `Total`, `Per-Page`, `Link`, and `Page` as described in [RFC-5988](https://tools.ietf.org/html/rfc5988).
+
+For example, to display 5 results per page and view the second page of a
+`GET` to `/networks`, your final request would be `GET /networks?....page=2&per_page=5`.
+
+## 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: 1.0.0
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+=end
+
+require 'spec_helper'
+
+describe VericredClient::ApiClient do
+  context 'initialization' do
+    context 'URL stuff' do
+      context 'host' do
+        it 'removes http from host' do
+          VericredClient.configure { |c| c.host = 'http://example.com' }
+          expect(VericredClient::Configuration.default.host).to eq('example.com')
+        end
+
+        it 'removes https from host' do
+          VericredClient.configure { |c| c.host = 'https://wookiee.com' }
+          expect(VericredClient::ApiClient.default.config.host).to eq('wookiee.com')
+        end
+
+        it 'removes trailing path from host' do
+          VericredClient.configure { |c| c.host = 'hobo.com/v4' }
+          expect(VericredClient::Configuration.default.host).to eq('hobo.com')
+        end
+      end
+
+      context 'base_path' do
+        it "prepends a slash to base_path" do
+          VericredClient.configure { |c| c.base_path = 'v4/dog' }
+          expect(VericredClient::Configuration.default.base_path).to eq('/v4/dog')
+        end
+
+        it "doesn't prepend a slash if one is already there" do
+          VericredClient.configure { |c| c.base_path = '/v4/dog' }
+          expect(VericredClient::Configuration.default.base_path).to eq('/v4/dog')
+        end
+
+        it "ends up as a blank string if nil" do
+          VericredClient.configure { |c| c.base_path = nil }
+          expect(VericredClient::Configuration.default.base_path).to eq('')
+        end
+      end
+    end
+  end
+
+  describe "#update_params_for_auth!" do
+    it "sets header api-key parameter with prefix" do
+      VericredClient.configure do |c|
+        c.api_key_prefix['api_key'] = 'PREFIX'
+        c.api_key['api_key'] = 'special-key'
+      end
+
+      api_client = VericredClient::ApiClient.new
+
+      config2 = VericredClient::Configuration.new do |c|
+        c.api_key_prefix['api_key'] = 'PREFIX2'
+        c.api_key['api_key'] = 'special-key2'
+      end
+      api_client2 = VericredClient::ApiClient.new(config2)
+
+      auth_names = ['api_key', 'unknown']
+
+      header_params = {}
+      query_params = {}
+      api_client.update_params_for_auth! header_params, query_params, auth_names
+      expect(header_params).to eq({'api_key' => 'PREFIX special-key'})
+      expect(query_params).to eq({})
+
+      header_params = {}
+      query_params = {}
+      api_client2.update_params_for_auth! header_params, query_params, auth_names
+      expect(header_params).to eq({'api_key' => 'PREFIX2 special-key2'})
+      expect(query_params).to eq({})
+    end
+
+    it "sets header api-key parameter without prefix" do
+      VericredClient.configure do |c|
+        c.api_key_prefix['api_key'] = nil
+        c.api_key['api_key'] = 'special-key'
+      end
+
+      api_client = VericredClient::ApiClient.new
+
+      header_params = {}
+      query_params = {}
+      auth_names = ['api_key', 'unknown']
+      api_client.update_params_for_auth! header_params, query_params, auth_names
+      expect(header_params).to eq({'api_key' => 'special-key'})
+      expect(query_params).to eq({})
+    end
+  end
+
+  describe "timeout in #build_request" do
+    let(:config) { VericredClient::Configuration.new }
+    let(:api_client) { VericredClient::ApiClient.new(config) }
+
+    it "defaults to 0" do
+      expect(VericredClient::Configuration.default.timeout).to eq(0)
+      expect(config.timeout).to eq(0)
+
+      request = api_client.build_request(:get, '/test')
+      expect(request.options[:timeout]).to eq(0)
+    end
+
+    it "can be customized" do
+      config.timeout = 100
+      request = api_client.build_request(:get, '/test')
+      expect(request.options[:timeout]).to eq(100)
+    end
+  end
+
+  describe "#deserialize" do
+    it "handles Array<Integer>" do
+      api_client = VericredClient::ApiClient.new
+      headers = {'Content-Type' => 'application/json'}
+      response = double('response', headers: headers, body: '[12, 34]')
+      data = api_client.deserialize(response, 'Array<Integer>')
+      expect(data).to be_instance_of(Array)
+      expect(data).to eq([12, 34])
+    end
+
+    it "handles Array<Array<Integer>>" do
+      api_client = VericredClient::ApiClient.new
+      headers = {'Content-Type' => 'application/json'}
+      response = double('response', headers: headers, body: '[[12, 34], [56]]')
+      data = api_client.deserialize(response, 'Array<Array<Integer>>')
+      expect(data).to be_instance_of(Array)
+      expect(data).to eq([[12, 34], [56]])
+    end
+
+    it "handles Hash<String, String>" do
+      api_client = VericredClient::ApiClient.new
+      headers = {'Content-Type' => 'application/json'}
+      response = double('response', headers: headers, body: '{"message": "Hello"}')
+      data = api_client.deserialize(response, 'Hash<String, String>')
+      expect(data).to be_instance_of(Hash)
+      expect(data).to eq({:message => 'Hello'})
+    end
+
+    it "handles Hash<String, Pet>" do
+      api_client = VericredClient::ApiClient.new
+      headers = {'Content-Type' => 'application/json'}
+      response = double('response', headers: headers, body: '{"pet": {"id": 1}}')
+      data = api_client.deserialize(response, 'Hash<String, Pet>')
+      expect(data).to be_instance_of(Hash)
+      expect(data.keys).to eq([:pet])
+
+      pet = data[:pet]
+      expect(pet).to be_instance_of(VericredClient::Pet)
+      expect(pet.id).to eq(1)
+    end
+
+    it "handles Hash<String, Hash<String, Pet>>" do
+      api_client = VericredClient::ApiClient.new
+      headers = {'Content-Type' => 'application/json'}
+      response = double('response', headers: headers, body: '{"data": {"pet": {"id": 1}}}')
+      result = api_client.deserialize(response, 'Hash<String, Hash<String, Pet>>')
+      expect(result).to be_instance_of(Hash)
+      expect(result.keys).to match_array([:data])
+
+      data = result[:data]
+      expect(data).to be_instance_of(Hash)
+      expect(data.keys).to match_array([:pet])
+
+      pet = data[:pet]
+      expect(pet).to be_instance_of(VericredClient::Pet)
+      expect(pet.id).to eq(1)
+    end
+  end
+
+  describe "#object_to_hash" do
+    it "ignores nils and includes empty arrays" do
+      api_client = VericredClient::ApiClient.new
+      pet = VericredClient::Pet.new
+      pet.id = 1
+      pet.name = ''
+      pet.status = nil
+      pet.photo_urls = nil
+      pet.tags = []
+      expected = {id: 1, name: '', tags: []}
+      expect(api_client.object_to_hash(pet)).to eq(expected)
+    end
+  end
+
+  describe "#build_collection_param" do
+    let(:param) { ['aa', 'bb', 'cc'] }
+    let(:api_client) { VericredClient::ApiClient.new }
+
+    it "works for csv" do
+      expect(api_client.build_collection_param(param, :csv)).to eq('aa,bb,cc')
+    end
+
+    it "works for ssv" do
+      expect(api_client.build_collection_param(param, :ssv)).to eq('aa bb cc')
+    end
+
+    it "works for tsv" do
+      expect(api_client.build_collection_param(param, :tsv)).to eq("aa\tbb\tcc")
+    end
+
+    it "works for pipes" do
+      expect(api_client.build_collection_param(param, :pipes)).to eq('aa|bb|cc')
+    end
+
+    it "works for multi" do
+      expect(api_client.build_collection_param(param, :multi)).to eq(['aa', 'bb', 'cc'])
+    end
+
+    it "fails for invalid collection format" do
+      expect(proc { api_client.build_collection_param(param, :INVALID) }).to raise_error(RuntimeError, 'unknown collection format: :INVALID')
+    end
+  end
+
+  describe "#json_mime?" do
+    let(:api_client) { VericredClient::ApiClient.new }
+
+    it "works" do
+      expect(api_client.json_mime?(nil)).to eq false
+      expect(api_client.json_mime?('')).to eq false
+
+      expect(api_client.json_mime?('application/json')).to eq true
+      expect(api_client.json_mime?('application/json; charset=UTF8')).to eq true
+      expect(api_client.json_mime?('APPLICATION/JSON')).to eq true
+
+      expect(api_client.json_mime?('application/xml')).to eq false
+      expect(api_client.json_mime?('text/plain')).to eq false
+      expect(api_client.json_mime?('application/jsonp')).to eq false
+    end
+  end
+
+  describe "#select_header_accept" do
+    let(:api_client) { VericredClient::ApiClient.new }
+
+    it "works" do
+      expect(api_client.select_header_accept(nil)).to be_nil
+      expect(api_client.select_header_accept([])).to be_nil
+
+      expect(api_client.select_header_accept(['application/json'])).to eq('application/json')
+      expect(api_client.select_header_accept(['application/xml', 'application/json; charset=UTF8'])).to eq('application/json; charset=UTF8')
+      expect(api_client.select_header_accept(['APPLICATION/JSON', 'text/html'])).to eq('APPLICATION/JSON')
+
+      expect(api_client.select_header_accept(['application/xml'])).to eq('application/xml')
+      expect(api_client.select_header_accept(['text/html', 'application/xml'])).to eq('text/html,application/xml')
+    end
+  end
+
+  describe "#select_header_content_type" do
+    let(:api_client) { VericredClient::ApiClient.new }
+
+    it "works" do
+      expect(api_client.select_header_content_type(nil)).to eq('application/json')
+      expect(api_client.select_header_content_type([])).to eq('application/json')
+
+      expect(api_client.select_header_content_type(['application/json'])).to eq('application/json')
+      expect(api_client.select_header_content_type(['application/xml', 'application/json; charset=UTF8'])).to eq('application/json; charset=UTF8')
+      expect(api_client.select_header_content_type(['APPLICATION/JSON', 'text/html'])).to eq('APPLICATION/JSON')
+      expect(api_client.select_header_content_type(['application/xml'])).to eq('application/xml')
+      expect(api_client.select_header_content_type(['text/plain', 'application/xml'])).to eq('text/plain')
+    end
+  end
+
+  describe "#sanitize_filename" do
+    let(:api_client) { VericredClient::ApiClient.new }
+
+    it "works" do
+      expect(api_client.sanitize_filename('sun')).to eq('sun')
+      expect(api_client.sanitize_filename('sun.gif')).to eq('sun.gif')
+      expect(api_client.sanitize_filename('../sun.gif')).to eq('sun.gif')
+      expect(api_client.sanitize_filename('/var/tmp/sun.gif')).to eq('sun.gif')
+      expect(api_client.sanitize_filename('./sun.gif')).to eq('sun.gif')
+      expect(api_client.sanitize_filename('..\sun.gif')).to eq('sun.gif')
+      expect(api_client.sanitize_filename('\var\tmp\sun.gif')).to eq('sun.gif')
+      expect(api_client.sanitize_filename('c:\var\tmp\sun.gif')).to eq('sun.gif')
+      expect(api_client.sanitize_filename('.\sun.gif')).to eq('sun.gif')
+    end
+  end
+end