doodle_client 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 30b6f7d4016a34100fc2395de7232d50aecdf638
-  data.tar.gz: 5aa8c7a1642e1ede7be211ae69a240e4e8c30783
+  metadata.gz: 5b908fcfc28f2f4f5370f29e87912ff984e65719
+  data.tar.gz: d312e36de77d4ea468fe4f05d3858891207e4d86
 SHA512:
-  metadata.gz: 075bbb5b7b6014059049bad1e537ed41403f9345dfeea4e74b0433e39e01b79668de2c259eb5dfc8113e897d490dd993f16be962027764158c4d820322018ca0
-  data.tar.gz: f250ab7cfa6e4cb5f335b68b08b10286f81c9e53ee651b985d55006a78c92024df1d70fc977467f796cb6a3066a87a2de3af3f4ab83a96d599ee0a14b3b95373
+  metadata.gz: 2d1ac72ddb5125cdeeac2c7dacffc121c95b1ef136659f6db4da649dca6b12361d38ac48ee171e856d9bb5a64cbd42d5cc10b8e6a78c0fb7478f3305164aaa27
+  data.tar.gz: 10ababe5828e62a9e9bc055456dc90801c87bb835708df9135f64b094622c76fc55944524a3a4c81f009f6bedada96b8c112cd9941231ec3d98cdfaa3ef346ff

data/.gitignore

@@ -7,3 +7,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+doodle_client-*gem

data/README.md

@@ -1,9 +1,5 @@
 # DoodleClient
 
-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/doodle_client`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
-
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -19,10 +15,72 @@ And then execute:
 Or install it yourself as:
 
     $ gem install doodle_client
+    
+### Troubleshooting
+
+Needs nokogiri, so you'll probably hit at least one dependency issue if you don't have it installed already.
+
+Try these 'one size fits all' approaches if you're stuck
+
+**Ubuntu/Debian** - `apt-get install build-essential patch ruby-dev zlib1g-dev liblzma-dev`
+
+**CentOS/Redhat** - `yum install gcc ruby-devel zlib-devel`
 
 ## Usage
 
-TODO: Write usage instructions here
+### Verify
+
+Checks if a provided URL or id is a valid doodle.com reference.
+
+Takes a string, returns true or false.
+
+```ruby
+ 2.3.0 :001 > require 'doodle_client'
+  => true
+ 2.3.0 :002 > DoodleClient.verify("http://doodle.com/poll/kfha4cefe7zutuqu")
+  => true
+ 2.3.0 :003 > DoodleClient.verify("kfha4cefe7zutuqu")
+  => true
+ 2.3.0 :004 > DoodleClient.verify("http://doodle.com/poll/notarealdoodleid")
+  => false
+ 2.3.0 :005 > DoodleClient.verify("notarealdoodleid")
+  => false
+```
+
+### List
+
+Lists the various options available on the poll. Currently doesn't have useul information like value.
+
+Takes a string of either URL or id again.
+
+```ruby
+ 2.3.0 :001 > require 'doodle_client'
+  => true
+ 2.3.0 :002 > DoodleClient.list("http://doodle.com/poll/kfha4cefe7zutuqu")
+  => [[checkbox:0xce6a1c type: checkbox name: option0 value: false], [checkbox:0xce6850 type: checkbox name: option1 value: false], [checkbox:0xce6634 type: checkbox name: option2 value: false], [checkbox:0xce6468 type: checkbox name: option3 value: false]]
+ 2.3.0 :003 > DoodleClient.list("kfha4cefe7zutuqu")
+  => [[checkbox:0xc8e77c type: checkbox name: option0 value: false], [checkbox:0xc8e560 type: checkbox name: option1 value: false], [checkbox:0xc8e344 type: checkbox name: option2 value: false], [checkbox:0xc8e164 type: checkbox name: option3 value: false]]
+
+```
+
+### Vote
+
+The main event, lets you vote on a poll. 
+
+Takes a string for URL/id, a string for the name you want to vote as and an array of true or false to reflect if you're attending or not.
+
+```ruby
+ 2.3.0 :001 > require 'doodle_client'
+  => true
+ 2.3.0 :002 > DoodleClient.vote("http://doodle.com/poll/kfha4cefe7zutuqu", "Sam", [true, false, true])
+  => true
+ 2.3.0 :003 > DoodleClient.vote("kfha4cefe7zutuqu", "Jim", [false, false, true])
+  => true
+```
+
+Resulting in:
+
+![Doodle](http://i.imgur.com/fOm7DjG.png)
 
 ## Development
 
@@ -32,7 +90,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/doodle_client.
+Bug reports and pull requests are welcome on GitHub at https://github.com/zyio/doodle_client.
 
 
 ## License

data/doodle_client.gemspec

@@ -17,7 +17,7 @@ Gem::Specification.new do |spec|
   # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
   # to allow pushing to a single host or delete this section to allow pushing to any host.
   if spec.respond_to?(:metadata)
-    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+      spec.metadata['allowed_push_host'] = "https://rubygems.org"
   else
     raise "RubyGems 2.0 or newer is required to protect against " \
       "public gem pushes."

data/lib/doodle_client/version.rb

@@ -1,3 +1,3 @@
 module DoodleClient
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: doodle_client
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Sam Norbury
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-11-06 00:00:00.000000000 Z
+date: 2016-11-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler