badgerkit 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ef4d5b0fc6e60ac2ce01bcc9d382ad68594f7f8c
-  data.tar.gz: 3d179b99e463f475c8eaf5d8d30373e9de0d12a0
+  metadata.gz: ee0809e3f5c17dbe9a141882641e975a006ceb69
+  data.tar.gz: a0ac6551aa9ec62352ee562c2eff4a2cbbcd1166
 SHA512:
-  metadata.gz: 66ba1da53b8df8f79cfcc4d950fafa6ee3b4e5317c7572856e3aa80d1a6c48fcd42f2b564ab48c3806e5b24733a060d184e4982ee446e88cf06c9b9ca513507b
-  data.tar.gz: e101973ccd5bf6cb313c6f17a6dd4e5e3906187c4e332ce426457d2f97743de9508b69c3cd721991ac9c8d7050c8e445984c7cccbea7fb9087675dc2f058b457
+  metadata.gz: d0123f5ad45bbb1ef338a39c432c064626c1486f7ec87a35fc1f88206d75286dc87e076390ba8bbcb9664e8acb7883a4f88ec874dcf9277917c199237f520630
+  data.tar.gz: 167c71e85c37c54c77b2e789c1c23be09f745b68a95e703cd56ee7d596b5b456263ae584d009eb9cbe3497f4e719a1b5fda777698dc44d9ba274bac24ecb290a

data/.yardopts

@@ -0,0 +1,4 @@
+--no-private
+--title=""
+--markup=markdown
+--charset utf-8

data/badgerkit.gemspec

@@ -22,6 +22,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake"
   spec.add_development_dependency 'coveralls'
   spec.add_development_dependency 'rspec', '>= 2.3'
+  spec.add_development_dependency 'yard'
 
   spec.add_dependency "httmultiparty"
   spec.add_dependency "hashie"

data/lib/badgerkit.rb

@@ -2,6 +2,9 @@ require "badgerkit/version"
 require "badgerkit/client"
 require "badgerkit/archive"
 
+##
+# Ruby toolkit for the Badgerkit api.
+#
 module Badgerkit
 
   ### Class methods

data/lib/badgerkit/archive.rb

@@ -1,4 +1,11 @@
 module Badgerkit
+  ##
+  # Adds ability to archive directories to {Badgerkit}.
+  #
+  # @see Badgerkit.archive
+  # @example
+  #   Badgerkit.archive('js-doc/')
+  #
   class Archive
     require 'rubygems'
     require 'zip'

data/lib/badgerkit/client.rb

@@ -1,6 +1,7 @@
 module Badgerkit
   ##
-  # Responsible for constructing a client which is able to post values.
+  # Responsible for constructing a client
+  # which is able to post values to badgherhq.com
   #
   class Client
     require 'httmultiparty'
@@ -8,10 +9,13 @@ module Badgerkit
 
     attr_reader :path, :access_token, :source, :repo
 
+    ##
+    # The base uri the perform requests to.
+    #
     BASE_URI = 'http://badgerhq.com/'
 
     ##
-    # Construct a new Badgekit::Client
+    # Construct a new Badgerkit::Client
     #
     # @param options [Hash]
     # @option token [String] :token
@@ -21,7 +25,7 @@ module Badgerkit
 
     # @return [Badgerkit::Client]
     # @example
-    #   Badgerkit::Client.new(
+    #   client = Badgerkit::Client.new(
     #     :access_token => '0dbce1478e94053d4282ccd4ace154c82a3475d5',
     #     :source       => 'github',
     #     :repo         => 'saladdays-nl/badgerkit'

data/lib/badgerkit/version.rb

@@ -1,4 +1,5 @@
+# @private
 module Badgerkit
-  VERSION = "0.0.6"
+  VERSION = "0.0.7"
 end # Badgerkit
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: badgerkit
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Johan van Zonneveld
@@ -66,6 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: httmultiparty
   requirement: !ruby/object:Gem::Requirement
@@ -131,6 +145,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
+- ".yardopts"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -178,3 +193,4 @@ test_files:
 - spec/fixtures/archive_folder/test.yml
 - spec/spec_helper.rb
 - spec/support/response_proxy.rb
+has_rdoc: