colo_biz 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6d8d0627cb02a72292a2c44ee91904384402270b
-  data.tar.gz: febf8974663a399980feccf96a2de5e5f0fd0bc7
+  metadata.gz: 24adbfca1f1511313ea582db4ad53ba7e5bcdc2f
+  data.tar.gz: acf1bd13b05e50ff72431bfd3aeef1d19a4f60fa
 SHA512:
-  metadata.gz: 414c1076b291dfe5a3a5e58e115e75dd075a17aa92437020255908bf20d9a64bf03f3e44266c384c601b118b10259ecb5e1efe356bb343979148e36970fc1e80
-  data.tar.gz: 95dc7354677ebd363352701eda4d49d276861f09dabbeea5994bfe914a9e285f9c7548d542b0056cbc43bdeab042fe7e2bc825a6517dae6209487052e13941c7
+  metadata.gz: 0749201947d907b4508793fc60b1a8e062b35a2ab5ad1fab675a00756bf9f09184723218c5fb80fb912ef5b00e7a8e8983c5df5fcd844a72554631cfd4fb42f4
+  data.tar.gz: f2f50a121875b163d6578a59fbdfbb7a5608ea104a87dda27901bbfd0a0f170364126b0168a385b00ae4516a95e724ba6d95c8671de10aa74e648e5ef84a3cc1

data/README.md

@@ -2,42 +2,48 @@
 
 [![Build Status](https://travis-ci.org/CaseyKelly/Colorado-Business-Entities-API-Gem.svg)](https://travis-ci.org/CaseyKelly/Colorado-Business-Entities-API-Gem)
 
-A Ruby interface to the Colorado Business Entities API.
+A Ruby interface to the Colorado Business Entities API. Documentation for the API can be found at https://data.colorado.gov/developers/docs/colorado-business-entities.
 
 ## Installation
     gem install colo_biz
 
-## Documentation
-  Any queries made with the ColoBiz::DataFetcher module will return an array of BizEntity objects with all the information returned in the JSON hashes turned into attributes of the BizEntity objects. The attributes on each object can be called by their [field name](https://data.colorado.gov/developers/docs/colorado-business-entities) in snake case. For example the field name principalcity can be called on any BizEntity object as @bizentity.principal_city.
-  For the time being the search_by_entity_name does a soft search but all other search terms must match exactly except for case.
-  Our gem covers most of the queries with a method taking a single argument right out of the box. However you can modify any query method by entering what you want to use as a search term then adding "&" and a clause or field search after it.
-  [Socrata](http://dev.socrata.com/docs/queries.html) gives some examples of useful clauses to add. Here is an example of how to use a couple. If you wanted to find all the businesses in Evergreen, CO you would first use the ColoBiz::DataFetcher.new.search_by_principle_city(city_name) method and pass in "evergreen" as the argument. The default limit if you do not set it is 1000 which is too low for almost any search. You can increase the limit returned to the max of 50000 by including "&$limit=50000" at the end of the string you pass in as the argument for the method. Your final method would look like .search_by_principle_city("evergreen&$limit=50000"). This would return all Business entities in evergreen; about 9000. You could also add [Fields](https://data.colorado.gov/developers/docs/colorado-business-entities) to filter by. An example of this is to modify the above search to only return LLC's by adding &entitytype=DLLC to the end of the arguement we're passing the query method: ColoBiz::DataFetcher.new.search_by_principle_city("evergreen&$limit=50000&entitytype=FLLC") Notice that you must use either DLLC for "Domestic Limited Liability Company" or FLLC for "Foreign Limited Liability Company".
-  If you feel comfortable with the clauses and fields described above you may be more comfortable stringing them together for your own query to use in the .custom_query(query) method. We did not write a pagination method to return more than 50000 results because it would be stored in memory. The entire dataset is about 1.3 million entities which we feel would be unwieldy in active memory as a single array of objects. If you are comfortable using [pagination](http://dev.socrata.com/docs/paging.html), you want more than 500000 results, and your writing to a data base then you can iterate over our custom query method and write to a database.
+## Configuration
+  Any queries made with the ColoBiz::DataFetcher module will return an array of businesses. For each business, all the business' attributes are returned in a JSON hash. The attributes of each object can be called by their [field name](https://data.colorado.gov/developers/docs/colorado-business-entities) in snake case.
 
+  For example, the field name principalcity can be called on any business object as:
+  ```ruby
+   @bizentity.principal_city
+  ```
+  For the time being, the search_by_entity_name does a soft search but all other search terms must match exactly except for case.
 
-[http://rdoc.info/gems/?????][documentation]
+  Our gem covers most of the queries with a method taking a single argument right out of the box, however, you can modify any query method by entering what you want to use as a search term then adding "&" and a clause or field search after it.
 
-[documentation]: http://rdoc.info/gems/?????
+  [Socrata](http://dev.socrata.com/docs/queries.html) gives some examples of useful clauses to add. Here are some examples of how to use a couple. If you wanted to find all the businesses in Evergreen, CO you would first use the ColoBiz::DataFetcher.new.search_by_principle_city(city_name) method and pass in "evergreen" as the argument.
+  ```ruby
+  ColoBiz::DataFetcher.new.search_by_principle_city("evergreen")
+  ```
 
-## Configuration
-How does a user configure this on their machine? What gems are required?
-```ruby
-CODE EXAMPLE
-```
+## Number of Responses
+
+  The default number of responses is only 1,000. You can increase the limit returned, up to the max of 50,000, by including "&$limit=50000" at the end of the string you pass in as the argument for the method. Your final method would look like .search_by_principle_city("evergreen&$limit=50000"). This would return all Business entities in evergreen; about 9,000.
 
-## Usage Examples
-After configuring a `client`, you can do the following things.
+  You can also filter the data with [fields](https://data.colorado.gov/developers/docs/colorado-business-entities). An example of this is to modify the above search to only return LLC's by adding "&entitytype=DLLC" to the end of the argument we're passing the query method:
+  ```ruby
+  ColoBiz::DataFetcher.new.search_by_principle_city("evergreen&$limit=50000&entitytype=FLLC")
+  ```
+  Notice that you must use either DLLC for "Domestic Limited Liability Company" or FLLC for "Foreign Limited Liability Company".
 
-**Find details for a particular business entity, such as its name, address, or status:**
-```ruby
-CODE EXAMPLE
-```
+  If you feel comfortable with the clauses and fields described above you may be more comfortable stringing them together for your own query to use in the .custom_query(query) method. We did not write a pagination method to return more than 50,000 results because it would be stored in memory.
 
-**Search and filter Colorado business entities by name, address, status, and more:**
-```ruby
-CODE EXAMPLE
-```
+  The entire dataset is about 1.3 million entities which we feel would be unwieldy in active memory as a single array of objects. If you are comfortable using [pagination](http://dev.socrata.com/docs/paging.html), you want more than 500,000 results and your writing to a database, then you can iterate over our custom query method and write to a database.
 
 ## Authors
-* Finnegan Hewitt [@FBH037](https://github.com/FBH037)
-* Casey Kelly [@CaseyKelly](https://github.com/CaseyKelly)
+Finnegan Hewitt
++ GitHub: [@FBH037](https://github.com/FBH037)
++ <fbhewitt@gmail.com>
+
+Casey Kelly
++ GitHub: [@CaseyKelly](https://github.com/CaseyKelly)
++ <casey.kelly@colorado.edu>
+
+NOTE: We built this gem recently while in gSchool in Denver. If you have any questions or suggestions about how to make this gem more useful, feel free to email us.

data/colo_biz.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
   s.name        = 'colo_biz'
-  s.version     = '0.0.2' #semver.org
-  s.date        = '2015-04-25'
+  s.version     = '0.1.0' #semver.org
+  s.date        = '2015-04-10'
   s.summary     = "Colorado Business Entities Gem"
   s.description = "A gem that turns the CO Business Entity API into ruby methods."
   s.authors     = ["Finnegan Hewitt", "Casey Kelly"]

data/lib/colo_biz/data_fetcher.rb

@@ -1,14 +1,8 @@
-# require 'faraday'
-# require 'json'
-# require 'rspec'
-# require_relative 'biz_entity'
-# require_relative 'core_ext/nil'
-# require_relative 'query_method'
 
 module ColoBiz
   class DataFetcher
     include ColoBiz::QueryMethod
-    
+
     def initialize
       @conn = Faraday.new(:url => 'https://data.colorado.gov') do |faraday|
         faraday.request  :url_encoded             # form-encode POST params
@@ -18,10 +12,8 @@ module ColoBiz
     end
 
     def biz_entity
-       response = @conn.get do |req|
-      req.url "/resource/colorado-business-entities.json"
-      # req.headers['X-App-Token'] =
-      # req.headers['Content-Type'] =
+      response = @conn.get do |req|
+        req.url "/resource/colorado-business-entities.json"
       end
       @parsed = JSON.parse(response.body)
       make_biz_entities(@parsed)

data/lib/colo_biz/query_method.rb

@@ -20,7 +20,6 @@ module ColoBiz
     make_biz_entities(parsed)
   end
 
-  #not tested yet
   def search_by_principal_city(city_name)
     response = @conn.get do |req|
       req.url "/resource/colorado-business-entities.json?principalcity=#{city_name}"
@@ -29,7 +28,6 @@ module ColoBiz
     make_biz_entities(parsed)
   end
 
-  #not tested yet
   def search_by_principal_state(state_name)
     response = @conn.get do |req|
       req.url "/resource/colorado-business-entities.json?principalstate=#{state_name}"
@@ -38,7 +36,6 @@ module ColoBiz
     make_biz_entities(parsed)
   end
 
-  #not tested yet
   def search_by_principal_zipcode(zipcode)
     response = @conn.get do |req|
       req.url "/resource/colorado-business-entities.json?principalzipcode=#{zipcode}"
@@ -47,7 +44,6 @@ module ColoBiz
     make_biz_entities(parsed)
   end
 
-  #not tested yet
   def search_by_principal_country(two_letter_country_code)
     response = @conn.get do |req|
       req.url "/resource/colorado-business-entities.json?principalcountry=#{two_letter_country_code}"
@@ -56,9 +52,7 @@ module ColoBiz
     make_biz_entities(parsed)
   end
 
-  #mailing address, city, state, zipcode, and country are skipped here
 
-  #not tested yet
   #e.g. "Withdrawn"
   def search_by_entity_status(entity_status)
     response = @conn.get do |req|
@@ -70,7 +64,6 @@ module ColoBiz
 
 
   #e.g. "Water Company"
-  #not tested
   def search_by_entity_type_verbatum(entity_type_verbatum)
     response = @conn.get do |req|
       req.url "/resource/colorado-business-entities.json?entitytypeverbatum=#{entity_type_verbatum}"
@@ -80,7 +73,6 @@ module ColoBiz
   end
 
   #Must be the acronym for the type. e.g. "WC" for water company
-  #not tested
   def search_by_entity_type(entity_type)
     response = @conn.get do |req|
       req.url "/resource/colorado-business-entities.json?entitytype=#{entity_type}"
@@ -90,7 +82,6 @@ module ColoBiz
   end
 
   #first and last name are not case sensitive
-  #not tested
   def search_by_agent_full_name(first_name, last_name)
     response = @conn.get do |req|
       req.url "/resource/colorado-business-entities.json?agentfirstname=#{first_name}&agentlastname=#{last_name}"
@@ -101,7 +92,6 @@ module ColoBiz
 
   #skipped agent middle name, agent suffix, agent organization name, agent principle address 1 and 2
 
-  #not tested
   def search_by_agent_principal_city(agent_principal_city)
     response = @conn.get do |req|
       req.url "/resource/colorado-business-entities.json?agentprincipalcity=#{agent_principal_city}"

data/spec/live_spec.rb

@@ -22,9 +22,10 @@ require 'spec_helper'
         gold_hill = ColoBiz::DataFetcher.new.search_by_entity_name("GOLD HILL MESA JOINT VENTURE, LLC")
         expect(gold_hill.first.entity_name).to eq "GOLD HILL MESA JOINT VENTURE, LLC"
       end
-
+      it 'returns a hash of entity information on successfull request' do
+        gold_hill = ColoBiz::DataFetcher.new.search_by_entity_name("GOLD HILL MESA JOINT VENTURE, LLC")
+        expect(gold_hill.first.entity_name).to eq "GOLD HILL MESA JOINT VENTURE, LLC"
+      end
     end
 
   end
-
-  # end

data/spec/spec_helper.rb

@@ -1,91 +1,10 @@
-# This file was generated by the `rspec --init` command. Conventionally, all
-# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
-# The generated `.rspec` file contains `--require spec_helper` which will cause
-# this file to always be loaded, without a need to explicitly require it in any
-# files.
-#
-# Given that it is always loaded, you are encouraged to keep this file as
-# light-weight as possible. Requiring heavyweight dependencies from this file
-# will add to the boot time of your test suite on EVERY test run, even for an
-# individual file that may not need all of that loaded. Instead, consider making
-# a separate helper file that requires the additional dependencies and performs
-# the additional setup, and require it from the spec files that actually need
-# it.
-#
-# The `.rspec` file also contains a few flags that are not defaults but that
-# users commonly want.
-#
-# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
 RSpec.configure do |config|
-  # rspec-expectations config goes here. You can use an alternate
-  # assertion/expectation library such as wrong or the stdlib/minitest
-  # assertions if you prefer.
   config.expect_with :rspec do |expectations|
-    # This option will default to `true` in RSpec 4. It makes the `description`
-    # and `failure_message` of custom matchers include text for helper methods
-    # defined using `chain`, e.g.:
-    #     be_bigger_than(2).and_smaller_than(4).description
-    #     # => "be bigger than 2 and smaller than 4"
-    # ...rather than:
-    #     # => "be bigger than 2"
     expectations.include_chain_clauses_in_custom_matcher_descriptions = true
   end
-
-  # rspec-mocks config goes here. You can use an alternate test double
-  # library (such as bogus or mocha) by changing the `mock_with` option here.
   config.mock_with :rspec do |mocks|
-    # Prevents you from mocking or stubbing a method that does not exist on
-    # a real object. This is generally recommended, and will default to
-    # `true` in RSpec 4.
     mocks.verify_partial_doubles = true
   end
 
-# The settings below are suggested to provide a good initial experience
-# with RSpec, but feel free to customize to your heart's content.
-=begin
-  # These two settings work together to allow you to limit a spec run
-  # to individual examples or groups you care about by tagging them with
-  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
-  # get run.
-  config.filter_run :focus
-  config.run_all_when_everything_filtered = true
-
-  # Limits the available syntax to the non-monkey patched syntax that is
-  # recommended. For more details, see:
-  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
-  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
-  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
-  config.disable_monkey_patching!
-
-  # This setting enables warnings. It's recommended, but in some cases may
-  # be too noisy due to issues in dependencies.
-  config.warnings = true
-
-  # Many RSpec users commonly either run the entire suite or an individual
-  # file, and it's useful to allow more verbose output when running an
-  # individual spec file.
-  if config.files_to_run.one?
-    # Use the documentation formatter for detailed output,
-    # unless a formatter has already been configured
-    # (e.g. via a command-line flag).
-    config.default_formatter = 'doc'
-  end
-
-  # Print the 10 slowest examples and example groups at the
-  # end of the spec run, to help surface which specs are running
-  # particularly slow.
-  config.profile_examples = 10
-
-  # Run specs in random order to surface order dependencies. If you find an
-  # order dependency and want to debug it, you can fix the order by providing
-  # the seed, which is printed after each run.
-  #     --seed 1234
-  config.order = :random
 
-  # Seed global randomization in this process using the `--seed` CLI option.
-  # Setting this allows you to use `--seed` to deterministically reproduce
-  # test failures related to randomization by passing the same `--seed` value
-  # as the one that triggered the failure.
-  Kernel.srand config.seed
-=end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: colo_biz
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - Finnegan Hewitt
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-25 00:00:00.000000000 Z
+date: 2015-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday