apicake 0.0.3 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 40e714671fc06714a55011b766e49b9b9864f844
-  data.tar.gz: 44de7eae53d8dc0de613d8a50b7a1ec69b6d66b0
+  metadata.gz: 6e7c41c224b2b2435828e862a3047a50aaf7ea6e
+  data.tar.gz: eacee61fff039351173484ea34db7d7d19a11b12
 SHA512:
-  metadata.gz: 72f08448fd1f559f837dfd6d689a86b4832d8b75e3259fabc82c7c2a23c2d6c512b9e9bce6e19921b39fab0726d6b8f409bba15938461d5a61e8c2cc31bf2c10
-  data.tar.gz: 6e5d65bd2804c5b325c96a3f459408f239f3b3f7b3984ed1c844b41d10a380f70aa33f6bab7cebb949001bc18d11bbad9cd0fa94b280bad36b2ff7912ef2af7d
+  metadata.gz: e08bb8197889886c32400bc2bc035a924d730b71eb9c03f2bd4b74e91cfdda7678693c6de867d204d6efb3cd37011ff8e2513b237dcce23151f4a380ab8e8ebe
+  data.tar.gz: c385af56680fbad9d96437f4ae9e9a24feea6a3250a9f83d6ec7e9dfd6eaa53f7fe93017e480e1fe64bea32d0effe37d3e9a0f623dc562659e65b265eb63d3ae

data/README.md

@@ -61,6 +61,7 @@ Features
 - Built in caching
 - Built in save to file
 - Built in response parsing (part of HTTParty)
+- Built in convert and save to CSV
 - Designed for GET-only APIs (e.g., data services)
 
 
@@ -115,4 +116,4 @@ Documentation to be completed
 
 [1]: https://github.com/DannyBen/apicake/tree/master/examples
 [2]: https://github.com/DannyBen/lightly
-[3]: https://github.com/DannyBen/apicake/blob/master/examples/04-caching.rb
+[3]: https://github.com/DannyBen/apicake/blob/master/examples/04-caching.rb

data/lib/apicake.rb

@@ -1,3 +1,4 @@
 require 'apicake/version'
 require 'apicake/base'
 require 'apicake/payload'
+require 'apicake/exceptions'

data/lib/apicake/base.rb

@@ -59,6 +59,50 @@ module APICake
       File.write filename, payload.response.body
     end
 
+    # Forwards all arguments to #get! and converts its parsed response to 
+    # CSV. If the response contains one or more arrays, the first array will
+    # be the CSV output, otherwise, the response itself will be used.
+    # You can override this method if you wish to provide a different 
+    # behavior.
+    def get_csv(*args)
+      payload = get!(*args)
+
+      if payload.response.code != '200'
+        raise BadResponse, "#{payload.response.code} #{payload.response.msg}"
+      end
+
+      response = payload.parsed_response
+
+      unless response.is_a? Hash
+        raise BadResponse, "Cannot parse response"
+      end
+      
+      data = csv_node response
+
+      header = data.first.keys
+      result = CSV.generate do |csv|
+        csv << header
+        data.each { |row| csv << row.values }
+      end
+
+      result
+    end
+
+    # Send a request, convert it to CSV and save it to a file.
+    def save_csv(file, *args)
+      File.write file, get_csv(*args)
+    end
+
+    # Determins which part of the data is best suited to be displayed 
+    # as CSV. 
+    # - In case there is an array in the data, it will be returned.
+    # - Otherwise, we will use the entire response as a single row CSV.
+    # Override this if you want to have a different decision process.
+    def csv_node(data)
+      arrays = data.keys.select { |key| data[key].is_a? Array }
+      arrays.empty? ? [data] : data[arrays.first]
+    end
+
     private
 
     # Make a call with HTTParty and return a payload object.

data/lib/apicake/exceptions.rb

@@ -0,0 +1,3 @@
+module APICake
+  class BadResponse < StandardError; end
+end

data/lib/apicake/version.rb

@@ -1,3 +1,3 @@
 module APICake
-  VERSION = "0.0.3"
+  VERSION = "0.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: apicake
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-17 00:00:00.000000000 Z
+date: 2017-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lightly
@@ -159,6 +159,7 @@ files:
 - README.md
 - lib/apicake.rb
 - lib/apicake/base.rb
+- lib/apicake/exceptions.rb
 - lib/apicake/payload.rb
 - lib/apicake/version.rb
 homepage: https://github.com/DannyBen/apicake