colo_biz 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8cbfa0ab6baca5fc145022ff61274779b3854d5b
+  data.tar.gz: 5edd38ac757fde0b0d677f267270063704681ef1
+SHA512:
+  metadata.gz: 67d91be2ec9c3ba64cdff0ebb1c7aa6abbda13464307f573dff9a1c6a970374c744b823737ce64f016de2ab13fcc7770646b9720132dd4044c1c9be55f97e4b4
+  data.tar.gz: 57aa0377853ba5b517b6ea277b2e70e28694047a628537f38f6a03b9905f7287daafcc7768379de90d22291cfb1e5afd57693dd2142b5f7e4a47abe52b5c4d71

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 2.2.0
+script:
+  - bundle exec rspec

data/Gemfile

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

data/README.md

@@ -0,0 +1,36 @@
+# The Colorado Business Entities API Ruby Gem
+
+[![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.
+
+## Installation
+    gem install colo_biz
+
+## Documentation
+[http://rdoc.info/gems/?????][documentation]
+
+[documentation]: http://rdoc.info/gems/?????
+
+## Configuration
+How does a user configure this on their machine? What gems are required?
+```ruby
+CODE EXAMPLE
+```
+
+## Usage Examples
+After configuring a `client`, you can do the following things.
+
+**Find details for a particular business entity, such as its name, address, or status:**
+```ruby
+CODE EXAMPLE
+```
+
+**Search and filter Colorado business entities by name, address, status, and more:**
+```ruby
+CODE EXAMPLE
+```
+
+## Authors
+* Finnegan Hewitt [@FBH037](https://github.com/FBH037)
+* Casey Kelly [@CaseyKelly](https://github.com/CaseyKelly)

data/colo_biz.gemspec

@@ -0,0 +1,17 @@
+Gem::Specification.new do |s|
+  s.name        = 'colo_biz'
+  s.version     = '0.0.1' #semver.org
+  s.date        = '2015-04-25'
+  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"]
+  s.email       = ['fbhewitt@gmail.com', 'casey.kelly@colorado.edu'] #can this take an array?
+  s.files       = `git ls-files -z`.split("\x0")
+  s.homepage    = 'https://github.com/CaseyKelly/Colorado-Business-Entities-API-Gem' # need to hoook up to rubygem API http://rubygems.org/gems/
+  s.license     = 'MIT'
+  s.add_runtime_dependency 'faraday'
+  s.add_runtime_dependency 'json'
+  s.add_development_dependency "bundler", "~> 1.7"
+  s.add_development_dependency "rake", "~> 10.0"
+  s.add_development_dependency "rspec"
+end

data/lib/colo_biz.rb

@@ -0,0 +1,8 @@
+module ColoBiz
+  require 'faraday'
+  require 'json'
+  require_relative 'core_ext/nil' #give path in gemspec
+  require_relative 'colo_biz/query_method' #load children first
+  require_relative 'colo_biz/biz_entity'
+  require_relative 'colo_biz/data_fetcher'
+end

data/lib/colo_biz/biz_entity.rb

@@ -0,0 +1,47 @@
+require_relative 'data_fetcher'
+
+class BizEntity
+
+  attr_reader :entity_name, :human_address, :longitude, :latitude, :entity_status,
+  :entity_form_date, :principal_address, :principal_city, :principal_state,
+  :principal_zipcode, :principal_country, :entity_type, :entity_type_verbatim,
+  :entity_id, :agent_first_name, :agent_middle_name, :agent_last_name,
+  :agent_address, :agent_city, :agent_state, :agent_zipcode,
+  :agent_principal_country, :mailing_zipcode, :mailing_country
+
+  def initialize(entity_hash)
+      @entity_name = entity_hash['entityname']
+      unless entity_hash['location']['human_address'] == ''
+        @human_address = JSON.parse(entity_hash['location']['human_address'])
+      else
+        @human_address = nil
+      end
+      @longitude = entity_hash['location']['longitude']
+      @latitude = entity_hash['location']['latitude']
+      @entity_status = entity_hash['entitystatus']
+      @entity_form_date = entity_hash['entityformdate'] #make this a date class
+      @principal_address = entity_hash['principaladdress1']
+      @principal_city = entity_hash['principalcity']
+      @principal_state = entity_hash['principalstate']
+      @principal_zipcode = entity_hash['principalzipcode']
+      @principal_country = entity_hash['principalcountry']
+      @entity_type = entity_hash['entitytype']
+      @entity_type_verbatim = entity_hash['entitytypeverbatim']
+      @entity_id = entity_hash['entityid'].to_i
+      @agent_first_name = entity_hash['agentfirstname']
+      @agent_middle_name = entity_hash['agentmiddlename']
+      @agent_last_name = entity_hash['agentlastname']
+      @agent_address = entity_hash['agentaddress']
+      @agent_city = entity_hash['agentcity']
+      @agent_state = entity_hash['agentstate']
+      @agent_zipcode = entity_hash['agentzipcode']
+      @agent_principal_country = entity_hash['agentprincipalcountry']
+      @mailing_zipcode = entity_hash['mailingzipcode']
+      @mailing_country = entity_hash['mailingcountry']
+  end
+
+  def mailing_address_string
+    "#{@human_address['address']}, #{@human_address['city']}, #{@human_address['state']}, #{@human_address['zip']}"
+  end
+
+end

data/lib/colo_biz/data_fetcher.rb

@@ -0,0 +1,36 @@
+# 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
+        faraday.response :logger                  # log requests to STDOUT
+        faraday.adapter  Faraday.default_adapter  # make requests with Net::HTTP
+      end
+    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'] =
+      end
+      @parsed = JSON.parse(response.body)
+      make_biz_entities(@parsed)
+    end
+
+    def make_biz_entities(entities)
+      entities.map do |entity|
+        BizEntity.new(entity)
+      end
+    end
+  end
+end

data/lib/colo_biz/query_method.rb

@@ -0,0 +1,190 @@
+# require_relative "data_fetcher"
+
+module ColoBiz
+  module QueryMethod
+
+  #The query does not search 'fuzzy' and needs the entire entity name
+  def search_by_entity_name(entity_name)
+    response = @conn.get do |req|
+      req.url "/resource/colorado-business-entities.json?entityname=#{entity_name}"
+    end
+    parsed = JSON.parse(response.body)
+    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}"
+    end
+    parsed = JSON.parse(response.body)
+    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}"
+    end
+    parsed = JSON.parse(response.body)
+    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}"
+    end
+    parsed = JSON.parse(response.body)
+    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}"
+    end
+    parsed = JSON.parse(response.body)
+    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|
+      req.url "/resource/colorado-business-entities.json?entitystatus=#{entity_status}"
+    end
+    parsed = JSON.parse(response.body)
+    make_biz_entities(parsed)
+  end
+
+
+  #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}"
+    end
+    parsed = JSON.parse(response.body)
+    make_biz_entities(parsed)
+  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}"
+    end
+    parsed = JSON.parse(response.body)
+    make_biz_entities(parsed)
+  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}"
+    end
+    parsed = JSON.parse(response.body)
+    make_biz_entities(parsed)
+  end
+
+  #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}"
+    end
+    parsed = JSON.parse(response.body)
+    make_biz_entities(parsed)
+  end
+
+  def search_by_agent_principal_state(agent_principal_state)
+    response = @conn.get do |req|
+      req.url "/resource/colorado-business-entities.json?agentprincipalstate=#{agent_principal_state}"
+    end
+    parsed = JSON.parse(response.body)
+    make_biz_entities(parsed)
+  end
+
+  def search_by_agent_principal_zipcode(agent_principal_zipcode)
+    response = @conn.get do |req|
+      req.url "/resource/colorado-business-entities.json?agentprincipalzipcode=#{agent_principal_zipcode}"
+    end
+    parsed = JSON.parse(response.body)
+    make_biz_entities(parsed)
+  end
+
+  def search_by_agent_principal_country(agent_principal_country)
+    response = @conn.get do |req|
+      req.url "/resource/colorado-business-entities.json?agentprincipalcountry=#{agent_principal_country}"
+    end
+    parsed = JSON.parse(response.body)
+    make_biz_entities(parsed)
+  end
+
+  #skipped agent mailing addres 1 and 2
+
+  def search_by_agent_mailing_city(agent_mailing_city)
+    response = @conn.get do |req|
+      req.url "/resource/colorado-business-entities.json?agentmailingcity=#{agent_mailing_city}"
+    end
+    parsed = JSON.parse(response.body)
+    make_biz_entities(parsed)
+  end
+
+  def search_by_agent_mailing_state(agent_mailing_state)
+    response = @conn.get do |req|
+      req.url "/resource/colorado-business-entities.json?agentmailingstate=#{agent_mailing_state}"
+    end
+    parsed = JSON.parse(response.body)
+    make_biz_entities(parsed)
+  end
+
+  def search_by_agent_mailing_zipcode(agent_mailing_zipcode)
+    response = @conn.get do |req|
+      req.url "/resource/colorado-business-entities.json?agentmailingzipcode=#{agent_mailing_zipcode}"
+    end
+    parsed = JSON.parse(response.body)
+    make_biz_entities(parsed)
+  end
+
+  def search_by_agent_mailing_city(agent_mailing_country)
+    response = @conn.get do |req|
+      req.url "/resource/colorado-business-entities.json?agentmailingcountry=#{agent_mailing_country}"
+    end
+    parsed = JSON.parse(response.body)
+    make_biz_entities(parsed)
+  end
+
+  #must be in 'YYYY-MM-DD' format
+  def search_for_entity_formations_after(date)
+    response = @conn.get do |req|
+      req.url "/resource/colorado-business-entities.json?entityformdate > #{date}"
+    end
+    parsed = JSON.parse(response.body)
+    make_biz_entities(parsed)
+  end
+
+  #must be in 'YYYY-MM-DD' format
+  def search_for_entities_formed_before(date)
+    response = @conn.get do |req|
+      req.url "/resource/colorado-business-entities.json?entityformdate < #{date}"
+    end
+    parsed = JSON.parse(response.body)
+    make_biz_entities(parsed)
+  end
+
+  #radius is measured in miles
+  def search_for_entities_(longitude, latitude, radius)
+    response = @conn.get do |req|
+      req.url "/resource/colorado-business-entities.json?$where=within_circle(location, #{longitude}, #{latitude}, #{radius*1609})"
+    end
+    parsed = JSON.parse(response.body)
+    make_biz_entities(parsed)
+  end
+  end
+end

data/lib/core_ext/nil.rb

@@ -0,0 +1,5 @@
+class NilClass
+  def [](key)
+    ''
+  end
+end

data/spec/live_spec.rb

@@ -0,0 +1,30 @@
+#this spec will make actual api calls
+require 'colo_biz'
+require 'spec_helper'
+
+  RSpec.describe ColoBiz do
+
+    describe 'Data_Fetcher functionality' do
+      it 'initializes' do
+        data_fetcher = ColoBiz::DataFetcher::Faraday.new
+        expect(data_fetcher.class).to eq Faraday::Connection
+      end
+
+      it "sets @url on initialize" do
+        data_fetcher = ColoBiz::DataFetcher::Faraday.new(:url => 'https://data.colorado.gov')
+        expect(data_fetcher.url_prefix.to_s).to eq 'https://data.colorado.gov/'
+      end
+    end
+
+#############Query Methods################
+    describe 'entity name response' do
+      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

@@ -0,0 +1,91 @@
+# 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

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: colo_biz
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Finnegan Hewitt
+- Casey Kelly
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  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'
+- !ruby/object:Gem::Dependency
+  name: json
+  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'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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'
+description: A gem that turns the CO Business Entity API into ruby methods.
+email:
+- fbhewitt@gmail.com
+- casey.kelly@colorado.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- colo_biz.gemspec
+- lib/colo_biz.rb
+- lib/colo_biz/biz_entity.rb
+- lib/colo_biz/data_fetcher.rb
+- lib/colo_biz/query_method.rb
+- lib/core_ext/nil.rb
+- spec/live_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/CaseyKelly/Colorado-Business-Entities-API-Gem
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Colorado Business Entities Gem
+test_files: []