jeapie 0.1.0 → 0.1.1

data/jeapie.gemspec

@@ -20,4 +20,10 @@ Gem::Specification.new do |gem|
 
   gem.add_dependency('activesupport')
   gem.add_development_dependency 'fakeweb', ['~> 1.3']
+
+  # documentation
+  gem.extra_rdoc_files = Dir.glob('*.md')
+  gem.rdoc_options = %w(--line-numbers --inline-source --no-private --protected --title Jeapie --main README.md --encoding=UTF-8)
+  gem.has_rdoc = 'yard'
+
 end

data/lib/jeapie.rb

@@ -3,12 +3,14 @@ require 'jeapie/version'
 require 'active_support/core_ext/object/blank'
 require 'active_support/json'
 
+# The primary namespace.
 module Jeapie
   class DeliverException < StandardError ; end
   extend self
   # app_token and user_key, you can get it from dashboard.jeapie.com
   attr_accessor :token, :user
   attr_accessor :message, :title, :device, :priority
+  # After call notify it contain result as {Net::HTTPCreated} object, for check result better see {#errors}
   attr_reader :result
 
   API_URL= 'https://api.jeapie.com/v1/send/message.json'
@@ -30,16 +32,20 @@ module Jeapie
   end
   alias_method :params, :parameters
 
+  # List of available fields, useful for unit test.
+  # @return Hash
   def keys
     @keys||= [:token, :user, :message, :title, :device, :priority]
   end
 
+  # Clear stored params, useful for unit tests.
   def clear
     keys.each do |k|
       Jeapie.instance_variable_set("@#{k}", nil)
     end
   end
 
+  # After call {#notify} it contain "false" if all OK, or [string] with error in other case.
   def errors
     return "Params not valid: #{@params_errors}" unless @params_errors && @params_errors.empty?
     return false if result.nil?
@@ -53,10 +59,14 @@ module Jeapie
     "code: #{result.code}, errors: #{arr['errors']}"
   end
 
-  # push a message to Jeapie
-  # example: notify message:'Backup complete'
-  # or: notify title:'Backup complete', message:'Time elapsed 50s, size: 500Mb', priority:-1, device:'Nexus7', user:'', token:''
-  # @return [String] the response from jeapie.com, in json.
+  # Send message to Jeapie.
+  # example:
+  #  notify message:'Backup complete'
+  # or:
+  #  notify title:'Backup complete', message:'Time elapsed 50s, size: 500Mb', priority:-1, device:'Nexus7', user:'', token:''
+  #
+  # If this method return +false+, you can check {#errors} for text, or you can use {#notify!} for raise +DeliverException+ if any problem
+  # @return [true, false]
   def notify(opts={message:''})
     data = params.merge(opts).select { |_, v| v != nil }
     return false unless params_errors(data).empty?
@@ -71,6 +81,7 @@ module Jeapie
     errors ? false : true
   end
 
+  # @return [true]
   def notify!(opts={message:''})
     raise DeliverException, errors unless notify(opts)
     true

data/lib/jeapie/version.rb

@@ -1,3 +1,3 @@
 module Jeapie
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

data/whatsnew.md

@@ -0,0 +1,2 @@
+## 0.1.1
+  * add YARD documentation

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jeapie
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -48,7 +48,9 @@ email:
 - regrahc@gmail.com
 executables: []
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- whatsnew.md
+- README.md
 files:
 - .gitignore
 - Gemfile
@@ -60,10 +62,20 @@ files:
 - lib/jeapie/version.rb
 - spec/lib/jeapie_spec.rb
 - spec/spec_helper.rb
+- whatsnew.md
 homepage: https://github.com/charger/jeapie
 licenses: []
 post_install_message: 
-rdoc_options: []
+rdoc_options:
+- --line-numbers
+- --inline-source
+- --no-private
+- --protected
+- --title
+- Jeapie
+- --main
+- README.md
+- --encoding=UTF-8
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement