apiify 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 280b2e333c5d3fd4b6781c10a86b6a1ea1da0334
+  data.tar.gz: b9626d82aa248f83af83bc714bcea9407e8d194b
+SHA512:
+  metadata.gz: 96924428e0d386d07c641cc275d3f05866a627895d608e63631959c785ac1fce8bde82896e5f4cbbcf3ff5c49540e895a33f7e68eb399a32b568804825596d3f
+  data.tar.gz: 3dd0185a479d664ed5f95b8ed0286e166e56bf774dfb362eb9cb2675bd2742eacc730ab15f65df1b989587df8a136c44b2571f20fd89b5eaf959cca4178cae7c

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+spec/fixtures/bunny.csv
+*.DS_Store
+apiify-0.1.0.gem

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.0
+before_install: gem install bundler -v 1.13.7

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Oscar Barlow
+
+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,73 @@
+# apiify
+
+apiify is a little gem that takes any .csv file and turns it into an API.
+
+It's aimed at large organisations, e.g. government departments, that publish a lot of data as .csv and who want a quick way to access this data as JSON in their digital services.
+
+## Requirements
+You will need to initialize a [Rails API-only application](http://edgeguides.rubyonrails.org/api_app.html) with a Postgres database, by running something like the following:
+
+    $ rails new <my-api> -d=postgresql --api
+
+Then make your database with `$ bin/rake db:create`.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'apiify'
+```
+
+And install with `bundle`. Or install it yourself as:
+
+    $ gem install apiify
+
+## Usage
+
+Locate the CSV file you want to turn into an API. The name of the CSV file will become the name of the database table you will create, so ensure it is named appropriately.
+
+**Bad:**
+* 2017-list_of_bunnies-FINALv2.csv
+
+**Good:**
+* bunny.csv
+
+In your Rails API project directory, run `$ apiify new <path-to-csv> [index]`. This will run an API-appropriate scaffold via rails (i.e. a model, controller, and serializer will be created; so will a migration). The optional [index] argument takes the name of a column header and indexes that column in the database.
+
+The model's properties will be derived from the CSV column headers, so ensure they are properly named. apiify auto-detects an appropriate property type based on the contents of each column.
+
+**Bad:**
+* sub_cat3
+
+**Good:**
+* breed_category
+
+apiify will prompt you to run `$ bin/rake db:migrate`. Do so.
+
+Then run `$ apiify import <path-to-csv>`. This will import each row in your CSV file as a new record in your database.
+
+Run `$ bin/rails s` to boot up your rails server. Visit `localhost:3000/<pluralised model name>` to see your data in lovely, lovely JSON format.
+
+Run `apiify help [COMMAND]` to see a list of commands and get help with their usage.
+
+## Features not supported
+This gem currently does not work with databases other than Postgresql.
+
+It currently does not support updating a database table based on a CSV input - it creates a new table each time the gem is used.
+
+Please take a look at the list of known issues before using the gem.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/oscar-barlow/apiify.
+
+## Authors
+* [Chris Cooper](https://github.com/cjcoops)
+* [Jenna Ramdenee](https://github.com/jennaramdenee)
+* [Keomony Khun](https://github.com/keomony)
+* [Oscar Barlow](https://github.com/oscar-barlow/)
+
+
+## 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/apiify.gemspec

@@ -0,0 +1,43 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'apiify/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "apiify"
+  spec.version       = Apiify::VERSION
+  spec.authors       = ["Chris Cooper", "Jenna Ramdenee", "Keomony Khun", "Oscar Barlow"]
+  spec.email         = ["oscar.barlow@gmail.com"]
+
+  spec.summary       = %q{takes a .csv file, churns out an API.}
+  spec.description   = %q{apiify is a little gem that takes any .csv file and turns it into an API.
+
+  It's aimed at large organisations, e.g. government departments, that publish a lot of data as .csv and who want a quick way to access this data as JSON in their digital services.}
+  spec.homepage      = "https://github.com/oscar-barlow/apiify"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  # 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 do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "cucumber", "~> 1.3"
+  spec.add_development_dependency "aruba", "~> 0.14.2"
+  spec.add_dependency "thor", "~> 0.19"
+  spec.add_runtime_dependency "active_model_serializers", "~> 0.10.0"
+
+end

data/bin/apiify

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require "apiify"
+
+Apiify::CLI.start( ARGV )

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "apiify"
+
+# 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/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/apiify

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require 'apiify/cli'
+
+Apiify::CLI.start

data/lib/apiify.rb

@@ -0,0 +1,8 @@
+require "apiify/version"
+require 'apiify/scaffolder'
+require 'apiify/csv_importer'
+require 'CSV'
+require 'thor'
+
+module Apiify
+end

data/lib/apiify/cli.rb

@@ -0,0 +1,38 @@
+require 'thor'
+require 'apiify'
+
+class Apiify::CLI < Thor
+
+  desc "new <path-to-your-csv> [index]", "extracts file name and creates a model and properties based on CSV file name and header columns"
+  long_desc <<-APIIFYNEW
+  This will run an API-appropriate scaffold via rails (i.e. a model,
+  controller, and serializer will be created; so will a migration).
+
+  The optional [index] argument takes the name of a column header and indexes that column in the database.
+
+  IMPORTANT: the name of the model is derived from the file name. Therefore,
+  please ensure your file is sensibly named:
+  \x5
+  Good: `bunny.csv` \x5
+  Bad: `2017-list_of_bunnies-FINALv2.csv`
+
+  APIIFYNEW
+  def new(csv_path, index_col = nil)
+    scaffolder = Apiify::Scaffolder.new
+    scaffolder.generate(csv_path, index_col)
+  end
+
+  desc "import <path-to-your-csv>", "extracts all rows from CSV and populates your database"
+  long_desc <<-APIIFYIMPORT
+  This command imports every row in your CSV to a new row your database.
+
+  IMPORTANT: make sure you have already run `apiify new` with your CSV, or
+  import won't know where to put your data!
+  APIIFYIMPORT
+  def import(csv_path)
+    importer = Apiify::CsvImporter.new
+    importer.import(csv_path)
+  end
+
+
+end

data/lib/apiify/csv_importer.rb

@@ -0,0 +1,32 @@
+class Apiify::CsvImporter
+
+  def import(csv_path)
+    create_rake_file
+    run_rake_task(csv_path)
+    output_message(csv_path)
+  end
+
+  def create_rake_file
+    File.open("./lib/tasks/importer.rake", 'w') do |f|
+      f.write("require 'CSV'
+      task :import_csv, [:file_path] => :environment do |t, args|
+        file_name = args[:file_path].split('/').last.split('.').first
+        model_name = file_name.capitalize.constantize
+        table = CSV.table(args[:file_path])
+        table.each do |row|
+          model_name.create!(row.to_hash)
+        end
+      end")
+    end
+  end
+
+  def run_rake_task(csv_path)
+    system("bin/rake import_csv\[#{csv_path}\]")
+  end
+
+  def output_message(csv_path)
+    rows = CSV.table("#{csv_path}").length
+    puts "#{rows} records imported successfully."
+  end
+
+end

data/lib/apiify/generators/rake.rb

@@ -0,0 +1,17 @@
+require 'thor/group'
+module Apiify
+  module Generators
+    class Rake < Thor::Group
+      include Thor::Actions
+
+      argument :group, :type => :string
+      argument :name, :type => :string
+
+      def create_group
+        empty_directory(group)
+      end
+
+      
+    end
+  end
+end

data/lib/apiify/scaffolder.rb

@@ -0,0 +1,70 @@
+class Apiify::Scaffolder
+
+  def generate(csv_path, index_col)
+    run_scaffold(csv_path, index_col)
+    confirm(csv_path, index_col)
+  end
+
+  def get_file_name(csv_path)
+    if is_a_csv?(csv_path)
+      get_file(csv_path).first
+    else
+      raise "Error: wrong file type. Please supply a .csv file"
+    end
+  end
+
+  def find_class(path)
+    table = CSV.table(path)
+    headers = table.headers
+    result = {}
+    headers.each do |header|
+      table.each do |row|
+        if row[header].class != Float
+          result[header] = row[header].class
+        else
+          result[header] = row[header].class
+          break
+        end
+      end
+    end
+    result
+  end
+
+  def hash_to_string(hash, index_col)
+    output_str = ""
+    hash.each do |key, value|
+      if !index_col.nil? && key.to_s == index_col
+        output_str += "#{key}:#{value.to_s.downcase}:index "
+      else
+        output_str += "#{key}:#{value.to_s.downcase} "
+      end
+    end
+    output_str.strip
+  end
+
+  def create_scaffold(csv_path, index_col)
+    model_name = get_file_name(csv_path).capitalize
+    hash_result = find_class(csv_path)
+    "bin/rails g scaffold #{model_name} #{hash_to_string(hash_result, index_col)}"
+  end
+
+  def run_scaffold(csv_path, index_col)
+    system(create_scaffold(csv_path, index_col))
+  end
+
+  def confirm(csv_path, index_col)
+    puts "Created #{get_file_name(csv_path).capitalize} model with properties #{hash_to_string(find_class(csv_path),index_col)}"
+    puts "Please run `bin/rake db:migrate`"
+  end
+
+  private
+
+  def is_a_csv?(csv_path)
+    get_file(csv_path).last == "csv"
+  end
+
+  def get_file(csv_path)
+    csv_path.split("/").last.split(".")
+  end
+
+end

data/lib/apiify/version.rb

@@ -0,0 +1,3 @@
+module Apiify
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,168 @@
+--- !ruby/object:Gem::Specification
+name: apiify
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Chris Cooper
+- Jenna Ramdenee
+- Keomony Khun
+- Oscar Barlow
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-01-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: aruba
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.2
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+- !ruby/object:Gem::Dependency
+  name: active_model_serializers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+description: |-
+  apiify is a little gem that takes any .csv file and turns it into an API.
+
+    It's aimed at large organisations, e.g. government departments, that publish a lot of data as .csv and who want a quick way to access this data as JSON in their digital services.
+email:
+- oscar.barlow@gmail.com
+executables:
+- apiify
+extensions: []
+extra_rdoc_files: []
+files:
+- ".DS_Store"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- apiify.gemspec
+- bin/apiify
+- bin/console
+- bin/setup
+- exe/apiify
+- lib/apiify.rb
+- lib/apiify/cli.rb
+- lib/apiify/csv_importer.rb
+- lib/apiify/generators/rake.rb
+- lib/apiify/scaffolder.rb
+- lib/apiify/version.rb
+homepage: https://github.com/oscar-barlow/apiify
+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.5.1
+signing_key: 
+specification_version: 4
+summary: takes a .csv file, churns out an API.
+test_files: []