heydan 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1ee89c19c81cd1085881148d715aebb67e5feff2
+  data.tar.gz: d9b8fd855f3ad595247b2bbe0310ea1f94921cd9
+SHA512:
+  metadata.gz: 86f5aab602eed69e4c1efb59950f54c07e25aa17ee3fadef6fc21ea5205ef3246cf029de5f9152d70700040140278b69352eb49cfdee60329b37b56b81f878e0
+  data.tar.gz: e78c0d64a5356e56dd5779c2d680ee2cc7211fca18dd9ffc66643aaaaad3dd64da9c2dc9526f17b50e3da61992083c19907f07e973aef7367713e3cd744e4205

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.0.0
+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 heydan.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,44 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features) \
+#  .select{|d| Dir.exists?(d) ? d : UI.warning("Directory #{d} does not exist")}
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+
+  
+end

data/LICENSE.txt

@@ -0,0 +1,11 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Dan Melton
+
+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,84 @@
+# HeyDan
+
+Why HeyDan? I wrote it to help answer questions. Every time you have a question about governments, I imagine you turning around and saying 'Hey Dan! how many governments have x or y?''
+
+At every civic company I've worked at, I needed to build some sort of government data munging tool set. I wrote HeyDan, partly for myself, and partly to share.
+
+The goal is to create an easy versino controlled data import and processing tool for single variables, attributes, properties, etc and an ultra fast http server backed by ElasticSearch with extreme filter capabilities and data extendability. This is not a data catalogue, its middleware to pull data from data catalogues and process it. 
+
+##Build Status
+
+[![Build Status](https://travis-ci.org/danmelton/heydan.svg?branch=master)](https://travis-ci.org/danmelton/heydan)
+
+## Installation
+
+You will need git, ruby and elastic search
+
+    $ gem install heydan
+
+## Command Line Usage
+
+HeyDan is meant to be used in a shell:
+
+    $ heydan help
+    #returns a list of commands you do
+
+    $ heydan setup
+    #sets up heydan in the current directory
+
+    $ heydan build --type optional
+    #creates the jurisdiction files in the jurisdictions folder
+
+    $ heydan sources sync
+    #pulls down sources into sources folder leveraging git
+
+    $ heydan sources build 
+    #builds through each source in the sources folder, optional parameters
+    #include --fromsource, --type, and FOLDER NAME VARIABLE
+
+    $ heydan sources add github_http_link.git
+    #clones a source from git repo and adds to settings file under sources
+
+    $heydan sources new FOLDER SOURCENAME VARIABLE
+    #creates or adds a new variable under sources/folder/sourcename and sources/folder/scripts/sourcenamevariable.rb
+
+    $ heydan import
+    #bulk imports the jurisdictions folder into elasticsearch for extreme search goodness
+
+    $ heydan server
+    #starts a sinatra server at localhost:4567/entities
+
+    $ heydan upload
+    #uploads contents of the datasets folder to aws as specified in the settings file.
+
+## Adding Data
+
+You can contribute to HeyDan by creating a new source folder on github. Look at https://github.com/danmelton/heydan_sources as an example.
+
+To create a new directory for data:
+
+    $ heydan sources new example example_source example_variable_name
+
+This will create a folder 'example' in sources/ with a json file name example_source and a ruby file inside example/script/example_variable_name.rb
+
+You can update json file with metadata about the source. Each variable also has metadata too. 
+
+The script file has three methods in it. A version, which defaults to 1; a type, which defaults to 'dataset'; and a build method with some sample code.
+
+At the end of the build method, you should have a 2 to multiple column @data variable with the first row as headers.
+
+You can add pry in the build method to help you troubleshoot:
+
+      require 'pry'
+      binding.pry
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on [GitHub Issues](https://github.com/danmelton/heydan/issues). 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 "heydan"
+
+# 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/heydan

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+begin
+  require 'rubygems'
+  gem 'heydan'
+rescue LoadError
+end
+
+require 'heydan'
+
+HeyDan::Cli.start(ARGV)

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/heydan.gemspec

@@ -0,0 +1,49 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'heydan/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "heydan"
+  spec.version       = HeyDan::VERSION
+  spec.authors       = ["Dan Melton"]
+  spec.email         = ["melton.dan@gmail.com"]
+
+  spec.summary       = %q{HeyDan munges data for jurisdictions}
+  spec.description   = %q{Use HeyDan to download, munge and manage data for jurisdictions}
+  spec.homepage      = "http://github.com/danmelton/heydan"
+  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        = "bin"
+  spec.executables   = ['heydan']
+  spec.require_paths = ["lib"]
+
+  #depedencies
+  spec.add_dependency "thor", "~> 0.19"
+  spec.add_dependency "rubyzip", "~>1.1"
+  spec.add_dependency "git", "~>1.2"
+  spec.add_dependency "pry", "~> 0.10"
+  spec.add_dependency "ruby-progressbar","~>1.7"
+  spec.add_dependency "elasticsearch","~>1.0"
+  spec.add_dependency "sinatra","~>1.4"
+  spec.add_dependency "sinatra-cross_origin","~>0.3"
+  spec.add_dependency "fog-aws", "~>0.7.5"
+
+  #development/test depedencies
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  
+  spec.add_development_dependency "guard-rspec"
+  spec.add_development_dependency "vcr"
+  spec.add_development_dependency "webmock"
+end

data/lib/heydan.rb

@@ -0,0 +1,65 @@
+
+module HeyDan
+
+  class << self
+    attr_accessor :help
+    attr_accessor :folders
+    attr_accessor :sources
+    attr_accessor :settings_file
+    attr_accessor :cdn
+    attr_accessor :options
+    attr_accessor :elasticsearch
+    attr_accessor :aws_access_id
+    attr_accessor :aws_secret_key
+    attr_accessor :aws_bucket
+    attr_accessor :aws_region
+
+    #calls help text when needed
+    def helper_text(method)
+      if self.help
+        HeyDan::HelpText.send(method)
+      end
+    end
+  end
+
+    self.settings_file = nil
+
+    self.help = true
+    
+    def self.help?
+      self.help
+    end
+
+    self.folders ||= {
+      jurisdictions: 'jurisdictions',
+      sources: 'sources',
+      downloads: 'downloads',
+      datasets: 'datasets'
+    }
+
+    self.sources = {
+      heydan_sources: 'https://github.com/danmelton/heydan_sources.git'
+    }
+
+    self.cdn = 'https://heydan.s3-us-west-1.amazonaws.com'
+
+    self.options = {}
+    self.elasticsearch = {url: 'http://localhost:9200'}
+end
+
+require_relative "heydan/version"
+require_relative "heydan/base"
+require_relative "heydan/help_text"
+require_relative "heydan/helper"
+require_relative "heydan/script"
+require_relative "heydan/script_file"
+require_relative "heydan/source_file"
+require_relative "heydan/jurisdiction_file"
+require_relative "heydan/open_civic_identifiers"
+require_relative "heydan/sources"
+require_relative "heydan/import"
+require_relative "heydan/server"
+require_relative "heydan/cdn"
+require_relative "heydan/cli"
+
+HeyDan::Base.load_or_create_settings

data/lib/heydan/base.rb

@@ -0,0 +1,72 @@
+require 'yaml'
+class HeyDan::Base
+
+  class << self
+    def setup(dir=nil)
+      setup_dir(dir) if dir
+      dir ||= Dir.pwd
+      load_or_create_settings dir
+      create_folders
+    end
+
+    def create_folders
+      HeyDan::folders.keys.each do |folder|
+        path = HeyDan::folders[folder]
+        FileUtils.mkdir_p path if !Dir.exist?(path)
+      end
+    end
+
+    def load_or_create_settings(dir=nil)
+      dir ||= Dir.pwd
+      HeyDan.settings_file ||= if ENV['HEYDAN_SETTINGS']
+        ENV['HEYDAN_SETTINGS']
+      else
+        File.join(dir, 'heydan_settings.yml')
+      end
+      return load_settings_file(HeyDan.settings_file) if File.exist?(HeyDan.settings_file)
+      create_settings_file(dir)
+      HeyDan.settings_file
+    end
+
+    def load_settings_file(settings_file)
+      settings = YAML.load(File.read(settings_file))
+      settings.keys.each do |key|
+        method = key.to_s + '='
+        HeyDan.send(method, settings[key]) if HeyDan.respond_to?(method)
+      end
+      HeyDan.settings_file = settings_file
+    end
+
+    def save_settings(settings_file=nil)
+      settings_file ||= HeyDan.settings_file
+      File.open(settings_file, 'w') do |f|
+        f.write({help: HeyDan.help, 
+          folders: HeyDan.folders, 
+          sources: HeyDan.sources,
+          elasticsearch: {url: 'http://localhost:9200'}
+        }.to_yaml)
+      end
+    end
+
+    def create_settings_file(dir)
+      setup_dir(dir)
+      setup_folders(dir)
+      settings_file = File.join(dir, 'heydan_settings.yml')
+      save_settings(settings_file)
+    end
+
+    def setup_dir(dir)
+      if !Dir.exist?(dir)
+        FileUtils.mkdir_p(dir)
+      end
+    end
+
+    def setup_folders(dir)
+      HeyDan::folders.keys.each do |folder| 
+        HeyDan::folders[folder] = File.join(dir,HeyDan::folders[folder])
+      end
+    end
+
+  end
+
+end

data/lib/heydan/cdn.rb

@@ -0,0 +1,30 @@
+class HeyDan::Cdn
+
+  #Upload files from the Downloads folder
+  def self.upload(names=[])
+    require 'fog/aws'
+    @connection = Fog::Storage.new({
+      provider: 'AWS',
+      region: HeyDan.aws_region,
+      aws_access_key_id: HeyDan.aws_access_id,
+      aws_secret_access_key: HeyDan.aws_secret_key
+    })
+    @directory = @connection.directories.get(HeyDan.aws_bucket)
+    if names.size == 0
+      files = Dir.glob("#{HeyDan.folders[:datasets]}/*.csv")
+    else
+      files = names.map { |f| File.join(HeyDan.folders[:datasets], "#{f}.csv")}
+    end
+    files.each do |f|
+      name = f.gsub("#{HeyDan.folders[:datasets]}/", '')
+      puts "uploading #{name}"
+      file = @directory.files.new({
+        :key    => name,
+        :body   => File.open(f, 'r'),
+        :public => true
+      })
+      file.save
+    end    
+  end
+
+end