webinarjam_api 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4ca64d2d13639388a6daf7ba99da1d04ac57d98c
-  data.tar.gz: 88b7658ac926863dcc4e7fdfb392e3926bfd688e
+  metadata.gz: c73ec0eef721417a7e9923af36eb3ed8c1129024
+  data.tar.gz: bf09e6faf8e76679a51d2a7690926e19e894cf24
 SHA512:
-  metadata.gz: 478ddf860025ad14b5c65339ba1e2fa296dbccaaf145cf602789fd35620f500e69049e410607a2963d40e099efbbf9818d86e450852e6848643eca237ac172c4
-  data.tar.gz: 53a4c6f6744e3db1ce184e3427e30a6374e1d133d75a05449ecb164096ebd3597c5876bd9dca119bef8488c2df9ce550719cbe00a6604a4895478bee6fce8c4b
+  metadata.gz: b637ed504fad7a4e95296f5e76d46d9371424564e856be94abed455a58ca570c37c9dffe3687057ff16b5d66c661a0954b5103bd783bdc78dcc28202a0d392f4
+  data.tar.gz: be1a9e130bc5f89a7d9c26059bb58ad2de9ce7912e28635d4e8847534e2be5faa6ccc41375a21a5d31b19103040014dc2ee0e6a03ae015e30fcc5f4835b9d629

data/README.md

@@ -1,8 +1,5 @@
 # WebinarjamApi
-
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/webinarjam_api`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+A simple ruby API wrapper for retrieving webinar data from WebinarJam. Currently WebinarJam's API only supports retrieval of webinars, no registrants. However you can add registrants to a webinar.
 
 ## Installation
 
@@ -22,17 +19,41 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### Configuration
+
+#### Create a client object:
+```ruby
+client = ::WebinarjamApi::Client.new('Your API Key')
+```
+Note: Pass in the API Key as a string, wrap it in quotes.
+
+#### Retrieve all your webinars:
+```ruby
+client.get_webinars
+```
 
-## Development
+#### Pass in the 'webinar_id' to retrieve the specific webinar:
+```ruby
+client.get_webinar(webinar_id)
+```
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+#### Add registrants to the webinar
+Create a registrant, required fields are name and email.
+```ruby
+registrant = {
+  'name' => 'Chico Manzana',
+  'email' => 'chico@manzana.com'
+}
+```
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+Pass in registrant, along with webinar_id and schedule into the register_person method.
+```ruby
+client.register_person(webinar_id, schedule, registrant)
+```
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/webinarjam_api.
+Bug reports and pull requests are welcome on GitHub at https://github.com/jzntam/webinarjam_api.
 
 
 ## License

data/lib/webinarjam_api/version.rb

@@ -1,3 +1,3 @@
 module WebinarjamApi
-  VERSION = "1.0.1"
+  VERSION = "1.0.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: webinarjam_api
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Jason Tam
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-10-28 00:00:00.000000000 Z
+date: 2015-11-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty