accredible-ruby 0.1.8 → 0.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3215fa05571869674a932321e67bb279dd3b7e02
-  data.tar.gz: 439468a8668ca4fd6796ec1eb633c2ccdbd387e2
+  metadata.gz: 07764fbf9847f0a6b47dc7a09903ca6b30dc8521
+  data.tar.gz: df088ea0c1bd238f43cba2cba57c9a4451bb27e4
 SHA512:
-  metadata.gz: ba3d26d15bd7b28887090aa9e34655c2d0f7ec2b041fea2cc9b03793940f271640133b92f3e6237e1e21ee48f6d61f464cd453d0b4cf7467e9d6f6366a012713
-  data.tar.gz: 8808ee31e391eb9ffcce06ff829d950fcc7b1cbda05e1c0ba3e80812a41a51d463f75529c7582823be49bab1ee88b825b86e8a289633a8d14fadf5ecd0e2a43f
+  metadata.gz: 028a92f60543dc78fa84be4fc6023bea90492554e622239825b8040cff6b6af884f6e4ea8c0909958061b609ff86c17749373c2ba77387125a554ec0b76abf19
+  data.tar.gz: a462a3fc43828da82b72f6e3226fae20a9b34c856c6bdb5323a183854b34878f47f4bad68f2c65bd1af49b7daca7d648edef2fecc49474cd201931cba8614726

data/README.md

@@ -1 +1,61 @@
 # accredible
+Install
+--------
+Add the following line to Gemfile:
+
+```ruby
+gem 'accredible-ruby'
+```
+and run `bundle install` from your shell.
+Then add the following line to an initializer, or appropriate config file.
+
+```ruby
+Accredible.api_key = ENV['ACCREDIBLE_API_KEY']
+```
+
+Basic Usage
+-----------
+```ruby
+# creating a certificate
+recipient = {name: "Jared Smith", email: "example@example.com"}
+credential = {name: "#{course.title}",
+  cohort_name: "Example Cohort",
+  description: "A certificate of completion for a cool course",
+  issued_on: "2016-03-15",
+  course_link: "http://onemonth.com/courses/one-month-rails"}
+
+# evidence and references are both optional but can be constructed like this
+  evidence =
+  [{description: "Evidence of completion",
+    url: "http://example.com/evidence",
+    category: "url"},
+{description: "Evidence of completion 2",
+file: "https://s3.amazonaws.com/accredible_api_evidence_items/files/12/original/open-uri20140316-15266-1m3by6h.jpeg",
+      category: "file"}]
+      references= [{description: "John worked hard", 
+        relationship: "managed",
+        referee: {name: "Jane Doe", 
+          email: "jane@example.com",
+          avatar: "https://placehold.it/100x100"}}
+      ]
+
+Accredible::Credential.create(
+    recipient: recipient, 
+    credential: credential,
+    evidence: evidence,
+    references: references)
+```
+
+Supported Ruby versions
+-----------------------
+  Currently only Ruby 2.0+ is supported. Contributions are welcome if you need to
+  support a different version.
+
+License
+-------
+Accredible-Ruby is is free software, and may be redistributed under the 
+terms specified in the [LICENSE](/LICENSE) file.
+
+Thanks to
+---------
+[One Month](http://onemonth.com) - For allowing this gem to be extracted and open sourced.

data/lib/accredible-ruby/credential.rb

@@ -6,7 +6,7 @@ module Accredible
       Accredible.request(uri) 
     end
 
-    def self.create(recipient:, credential:, evidence: {}, references: {})
+    def self.create(recipient:, credential:, evidence: [], references: [])
       params = Util.build_create_credential_params(recipient, credential, evidence, references)
       uri = Credential.api_end_point
       Accredible.request(uri, :post, params)

data/lib/accredible-ruby/version.rb

@@ -1,3 +1,3 @@
 module Accredible
-  VERSION = "0.1.8"
+  VERSION = "0.1.9"
 end

data/spec/support/credential_helper.rb

@@ -21,7 +21,7 @@ module CredentialHelper
 
   def reference_details
     {description: "John worked hard", 
-     relationshi: "managed",
+     relationship: "managed",
      referee: {name: "Jane Doe", 
                email: "jane@example.com",
                avatar: "https://placehold.it/100x100"}}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: accredible-ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 0.1.9
 platform: ruby
 authors:
 - Jared Smith
@@ -160,7 +160,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.1
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Accredible API gem