poet_frost_API 0.0.2 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8719a30317bb3823939fbab9bbe3bd0437343e6d
-  data.tar.gz: 64c12685ef64b9869d2ddf2bd52bd70f49f72540
+  metadata.gz: bc264446329a6b68234216a770d86e31b71475cd
+  data.tar.gz: 5cdefd445cbbeac411c6d81a31dba838455921e2
 SHA512:
-  metadata.gz: 38f2430c3196e2016575a4e390f11240b0e0ab6caface54e3a3e31088fbb6baf93b8b4d11e970ce601be80a3e559e14edbddcce23d5f8988f4322fbf06d2d256
-  data.tar.gz: a95d7ed28fb36acb6899a548fad064186855a398f96a8f91eb982755aa25e5219c6571f4264c3f0f47dc3c5a02fb35c873b8f215cc2a2e2a0cdc2f07eeb17612
+  metadata.gz: 594995c675c54b5724a45c17ec5b4d3d2fab931a3bf21d76f0e0d78c9058a69237f5c9212686a8c11927395cc6ca27547b41faccceaaf7bc57cf7745c8db1213
+  data.tar.gz: 3a4e6703bc4bcf176a4a3200143b1e995e82ef34c55ebb0efdf89aea03d6c23ba29b36fcb97f916a175abf28c6b410a1876205a6dc3317a36da65ef572f5ed29

data/lib/{poet_frost_api.rb → poet_frost_API.rb}

@@ -4,6 +4,8 @@ require 'date'
 
 # To use any of the methods, register an API key at https://frost.po.et/
 # and save it as the environment variable FROST_TOKEN.
+# For the current easiest way to integrate to Rails, see the github readme
+# here: https://github.com/minstrel/Poet-Frost-API-Wrapper
 module PoetFrostAPI
 
   @@api_key = ENV['FROST_TOKEN']
@@ -13,13 +15,17 @@ module PoetFrostAPI
 
   # Register a work on Po.et.
   #
-  # Usage: PoetFrostAPI.create_work(name: 'Work Name',
-  #                                 datePublished: DateTime.now.iso8601,
-  #                                 dateCreated: DateTime.now.iso8601,
-  #                                 author: 'Author Name'
-  #                                 tags: 'Tag1, Tag2'
-  #                                 content: 'Content body'
-  #                                 )
+  # Usage:
+  # PoetFrostAPI.create_work(name: 'Work Name',
+  #                          datePublished: DateTime.now.iso8601,
+  #                          dateCreated: DateTime.now.iso8601,
+  #                          author: 'Author Name'
+  #                          tags: 'Tag1, Tag2'
+  #                          content: 'Content body'
+  #                          )
+  #
+  # datePublished and dateCreated will default to current datetime if omitted
+  # tags will default to blank string if omitted
   #
   # Returns a string with the workid that was registered.
   def PoetFrostAPI.create_work(args = {})
@@ -27,23 +33,27 @@ module PoetFrostAPI
     req = Net::HTTP::Post.new(@@uri.path)
     req.content_type = 'application/json'
     req['token'] = @@api_key
-    req.body = { name: args[:name],
-                 datePublished: args[:datePublished] || DateTime.now.iso8601,
-                 dateCreated: args[:dateCreated] || DateTime.now.iso8601,
-                 author: args[:author],
-                 tags: args[:tags] || '',
-                 content: args[:content]
-    }.to_json
+    args.keep_if { |k, v| [:name,
+                           :datePublished,
+                           :dateCreated,
+                           :author,
+                           :tags,
+                           :content].include?(k) }
+    args[:datePublished] ||= DateTime.now.iso8601
+    args[:dateCreated] ||= DateTime.now.iso8601
+    args[:tags] ||= ''
+    req.body = args.to_json
     res = @@http.request(req)
     JSON.parse(res.body)['workId']
   rescue => e
-    puts "failed #{e}"
+    "failed #{e}"
   end
 
   # Retrieve a specific work from Po.et, using the workId returned from
   # create_work.
   #
-  # Usage: PoetFrostAPI.get_work(workId)
+  # Usage:
+  # PoetFrostAPI.get_work(workId)
   #
   # Returns a hash with the created fields.
   def PoetFrostAPI.get_work(workId)
@@ -54,11 +64,15 @@ module PoetFrostAPI
     res = @@http.request(req)
     JSON.parse(res.body)
   rescue => e
-    puts "failed #{e}"
+    "failed #{e}"
   end
 
   # Retrieve all works submitted by your Frost API Token.
   #
+  # Usage:
+  # PoetFrostAPI.get_all_works
+  #
+  # Returns an array of individual works (hashes)
   def PoetFrostAPI.get_all_works
     req = Net::HTTP::Get.new(@@uri.path)
     req.content_type = 'application/json'
@@ -66,7 +80,7 @@ module PoetFrostAPI
     res = @@http.request(req)
     JSON.parse(res.body)
   rescue => e
-    puts "failed #{e}"
+    "failed #{e}"
   end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: poet_frost_API
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.4
 platform: ruby
 authors:
 - Donald Smith
@@ -16,7 +16,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/poet_frost_api.rb
+- lib/poet_frost_API.rb
 homepage: https://github.com/minstrel/Poet-Frost-API-Wrapper
 licenses:
 - MIT