csv2api 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e4d79887071ea990b18f00ffb329d718a1603965
-  data.tar.gz: 5ac6cac16217b800f1d5777698b312ce690bbd78
+  metadata.gz: 245ac997c6252b30230fedf04586ccae04b2eeb1
+  data.tar.gz: 3b886a7ad499db858d87ed66d3aa0463a0b3f358
 SHA512:
-  metadata.gz: 668916f02c35a22396cd5b33671705c2b0ce5d287d93986e91609f3647f93d6a96cab50375e5b34cdf02b8c604adf9299436de64045490f423cf0607183ee422
-  data.tar.gz: 9b790f0b073b8937d8bb096f7b1c163f52d6e982803731e27eabb2071b15c441bd1cb122d70e688f459713dd38c2c653c9ba8d038dfa35a9e12c7d75a734eba2
+  metadata.gz: 7ce4141c440da7152fb6001c324c906ad4d09f87e4c586ba1ffeadc14401d275adfcff45cdbc4c9088eb3203b007fa72a54439d75af83fc72aa5caab8dc59962
+  data.tar.gz: dc99410e6be1d4f1d9c076d40584bf79f508385213d3908555a07c32e0296b4572ca69a659fce2a5df52d6ad4b84d1f475bbc075aff26f047c7295b050df063c

data/Changelog.md

@@ -1,7 +1,13 @@
 # CSV2API Changelog
 
+## 0.1.0
+
+Released June 3, 2014 ([0.1.0](https://github.com/jonahoffline/csv2api/tree/v0.1.0)).
+
+* Add XML `Content-Type` response support
+
 ## 0.0.1
 
 Released May 27, 2014 ([0.0.1](https://github.com/jonahoffline/csv2api/tree/v0.0.1)).
 
-* Initial Release.
+* Initial Release.

data/README.md

@@ -1,12 +1,17 @@
 # CSV2API
+[![Build Status](https://travis-ci.org/jonahoffline/csv2api.svg)](https://travis-ci.org/jonahoffline/csv2api)
+[![Gem Version](https://badge.fury.io/rb/csv2api.svg)](http://badge.fury.io/rb/csv2api)
+[![Dependency Status](https://gemnasium.com/jonahoffline/csv2api.svg)](https://gemnasium.com/jonahoffline/csv2api)
+[![Code Climate](https://codeclimate.com/github/jonahoffline/csv2api.png)](https://codeclimate.com/github/jonahoffline/csv2api)
+[![Inline docs](http://inch-pages.github.io/github/jonahoffline/csv2api.png)](http://inch-pages.github.io/github/jonahoffline/csv2api)
 
-Auto-create json APIs from csv files. Instant endpoints without any hassle
+Auto-create json and xml APIs from csv files. Instant endpoints without any hassle.
 
 ## Why should I use this?
 
 * Your boss/client hates you so they insist on sending you .csv files for their data.
 * You need to do a quick prototype and don't want to waste time importing / converting
-* You're bored and want to write an app with pre-historical data you found on a floppy!
+* You're bored and want to write an app with pre-historical data that you found on a floppy!
 * Your life depends on it (**Disclaimer:** *Use at your own risk, jk you should be fine!*)
 
 ## Installation
@@ -31,7 +36,7 @@ tasks.csv - http://localhost:3000/tasks
 weather.csv - http://localhost:3000/weather
 ```
 
-**Note**: Endpoints can be accessed with simple name or their .json extension.
+**Note**: Endpoints can be accessed with the filename or their `.json`, `.xml` extensions.
 
 ### Load a specific folder
   $csv2api -d office_stuff/sad_csvs/

data/csv2api.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.version       = CSV2API::VERSION
   spec.authors       = ['Jonah Ruiz']
   spec.email         = ['jonah@pixelhipsters.com']
-  spec.summary       = %q(Auto-create json API endpoints from csv files.)
-  spec.description   = %q(Auto-create json APIs from csv files. Instantaneously)
+  spec.description   = %q(Auto-create json & xml APIs endpoints from csv files.)
+  spec.summary       = %q(Auto-create API endpoints from csv files.)
   spec.homepage      = 'https://github.com/jonahoffline/csv2api'
   spec.license       = 'MIT'
 
@@ -26,4 +26,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rack-test', '~> 0.6.2'
 
   spec.add_dependency 'sinatra', '~> 1.4.5'
+  spec.add_dependency 'activesupport', '~> 4.1.1'
+  spec.add_dependency 'builder', '~> 3.2.2'
 end

data/lib/csv2api/server.rb

@@ -14,25 +14,34 @@ module CSV2API
     end
 
     # Auto-creates endpoints from filenames
-    # @example
-    #   If :files contains 'tasks.csv', it will generate an endpoint like:
+    #  Endpoints will be reachable at depending on format
     #
-    #     get '/tasks' do
-    #       content_type :json
-    #       # (obvious code omitted...)
-    #       # (will only return the json version of csv)
-    #     end
-    #
-    #  Endpoint will be reachable at any of the following urls:
-    #  http://localhost:4567/tasks or http://localhost:4567/tasks.json
+    #    JSON (the default):
+    #      http://localhost:4567/tasks
+    #      http://localhost:4567/tasks.json
     #
+    #    XML:
+    #     http://localhost:4567/tasks.xml
     settings.files.each do |endpoint|
       get "/#{endpoint}.?:format?" do
-        content_type :json
+        csv_data = load_data(endpoint)
 
-        csv_file = load_csv(settings.csv_path, endpoint)
-        generate_json(CSV2API::Parser.new(csv_file).all)
+        if params[:format].eql?('xml')
+          content_type :xml
+          csv_data.to_xml(root: endpoint)
+        else
+          content_type :json
+          generate_json(csv_data)
+        end
       end
     end
+
+    # Loads data for response
+    # @param endpoint [String] endpoint name
+    # @return [Array<Hash>] csv data
+    def load_data(endpoint)
+      csv_file = load_csv(settings.csv_path, endpoint)
+      CSV2API::Parser.new(csv_file).all
+    end
   end
 end

data/lib/csv2api/version.rb

@@ -1,5 +1,5 @@
 module CSV2API
   # @author Jonah Ruiz <jonah@pixelhipsters.com>
   # Contains the version namespaced
-  VERSION = '0.0.1'
+  VERSION = '0.1.0'
 end

data/lib/csv2api.rb

@@ -1,6 +1,7 @@
 require 'csv2api/version'
 require 'csv2api/utils'
 require 'csv2api/parser'
+require 'active_support/core_ext'
 
 # @author Jonah Ruiz <jonah@pixelhipsters.com>
 # Auto-creates API endpoints from csv files

data/spec/csv2api/server_spec.rb

@@ -1,5 +1,4 @@
 require 'spec_helper'
-require 'ostruct'
 describe CSV2API::Server do
   include Rack::Test::Methods
 
@@ -8,18 +7,50 @@ describe CSV2API::Server do
   end
 
   describe '/tasks' do
-    it 'returns tasks.csv in json' do
-      get '/tasks'
-      expect(last_response.body).not_to be_empty
-      expect(last_response).to be_ok
+    context 'when called with .json extension' do
+      it 'returns tasks.csv in json' do
+        get '/tasks'
+        expect(last_response.body).not_to be_empty
+        expect(last_response).to be_ok
+
+        parsed_response = json(last_response.body).first
+        expect(parsed_response).to be_a(Hash)
+      end
+    end
+
+    context 'when called with .xml extension' do
+      it 'returns tasks.csv in XML' do
+        get '/tasks.xml'
+        expect(last_response.body).not_to be_empty
+        expect(last_response).to be_ok
+
+        parsed_response = xml(last_response.body)
+        expect(parsed_response).to be_a(Hash)
+      end
     end
   end
 
   describe '/transaction' do
-    it 'returns transaction.csv in json' do
-      get '/transaction'
-      expect(last_response.body).not_to be_empty
-      expect(last_response).to be_ok
+    context 'when called without .json extension' do
+      it 'returns transaction.csv in json' do
+        get '/transaction'
+        expect(last_response.body).not_to be_empty
+        expect(last_response).to be_ok
+
+        parsed_response = json(last_response.body).first
+        expect(parsed_response).to be_a(Hash)
+      end
+    end
+
+    context 'when called with .xml extension' do
+      it 'returns transaction.csv in XML' do
+        get '/transaction.xml'
+        expect(last_response.body).not_to be_empty
+        expect(last_response).to be_ok
+
+        parsed_response = xml(last_response.body)
+        expect(parsed_response).to be_a(Hash)
+      end
     end
   end
 end

data/spec/spec_helper.rb

@@ -16,3 +16,11 @@ def load_fixture(csv_file)
   path = File.join(File.dirname(__FILE__), 'fixtures', "#{csv_file}.csv")
   File.read(path)
 end
+
+def json(body)
+  JSON.parse(body)
+end
+
+def xml(xml)
+  Hash.from_xml(xml)
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: csv2api
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Jonah Ruiz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-28 00:00:00.000000000 Z
+date: 2014-06-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -94,7 +94,35 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.4.5
-description: Auto-create json APIs from csv files. Instantaneously
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.1.1
+- !ruby/object:Gem::Dependency
+  name: builder
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.2
+description: Auto-create json & xml APIs endpoints from csv files.
 email:
 - jonah@pixelhipsters.com
 executables:
@@ -152,7 +180,7 @@ rubyforge_project:
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: Auto-create json API endpoints from csv files.
+summary: Auto-create API endpoints from csv files.
 test_files:
 - spec/csv2api/csv2api_spec.rb
 - spec/csv2api/parser_spec.rb