agent_orange 0.1.4 → 0.1.5

data/.gitignore

@@ -1,3 +1,5 @@
 .bundle
 Gemfile.lock
 pkg/*
+.yardoc
+doc

data/README.rdoc

@@ -116,7 +116,7 @@ If you're going to use it with Rails then add the gem to your Gemfile.
 
 == General Class Definition
 
-This is not up to date or a reflection of the actual class structure. This will be updated eventually.
+This is not up to date or a reflection of the actual class structure. This will be updated eventually.  See http://rubydoc.info/gems/agent_orange/frames for more detailed docs.
 
 AgentOrange::UserAgent
   device
@@ -165,6 +165,7 @@ A warm thank you to all contributors to the project, who have put effort and tim
 * Alexander Rozumiy (@brain-geek) - Rspec testing for 1.9, updated travis-ci config, updated useragents to test against.
 * Joe Lencioni (@lencioni) - Improved bot detection.
 * Todd Huss (@thuss) of Two Bit Labs (@twobitlabs) - Google Mobile crawler detection as mobile and bot.
+* Aidan Feldman (@afeld) - Initial YARD documentation, and minor fix.
 
 == License
 

data/lib/agent_orange/browser.rb

@@ -3,7 +3,15 @@ require 'agent_orange/version'
 
 module AgentOrange
   class Browser < Base
-    attr_accessor :type, :name, :version
+    # @return [Symbol] one of the keys from {BROWSERS}
+    attr_accessor :type
+
+    # @return [String] one of the values from {BROWSERS}
+    attr_accessor :name
+
+    # @return [AgentOrange::Version]
+    attr_accessor :version
+
     attr_accessor :security
 
     BROWSERS = {
@@ -63,6 +71,7 @@ module AgentOrange
       AgentOrange.debug "", 2
     end
 
+    # @return {String}
     def to_s
       [self.name, self.version].compact.join(' ')
     end

data/lib/agent_orange/device.rb

@@ -6,9 +6,25 @@ require 'agent_orange/version'
 
 module AgentOrange
   class Device < Base
-    attr_accessor :type, :name, :version, :bot
+    # @return [Symbol] one of the keys from {DEVICES}
+    attr_accessor :type
+
+    # @return [String]
+    attr_accessor :name
+
+    # @return [AgentOrange::Version]
+    attr_accessor :version
+
+    # @return [Boolean]
+    attr_accessor :bot
+
+    # @return [AgentOrange::Platform]
     attr_accessor :platform
+
+    # @return [AgentOrange::OperatingSystem]
     attr_accessor :operating_system
+
+    # @return [AgentOrange::Engine]
     attr_accessor :engine
 
     DEVICES = {
@@ -59,6 +75,7 @@ module AgentOrange
       AgentOrange.debug "", 2
     end
 
+    # @return [Boolean]
     def is_computer?(name=nil)
       if name
         case name
@@ -72,6 +89,7 @@ module AgentOrange
       end
     end
 
+    # @return [Boolean]
     def is_mobile?(name=nil)
       if !name.nil? && !self.platform.name.nil?
         case name
@@ -85,6 +103,7 @@ module AgentOrange
       end
     end
 
+    # @return [Boolean]
     def is_bot?(name=nil)
       if name
         case name
@@ -98,6 +117,7 @@ module AgentOrange
       end
     end
 
+    # @return [String]
     def to_s
       [self.name, self.version].compact.join(' ')
     end

data/lib/agent_orange/engine.rb

@@ -5,7 +5,16 @@ require 'pp'
 
 module AgentOrange
   class Engine < Base
-    attr_accessor :type, :name, :version
+    # @return [Symbol] one of the keys from {ENGINES}
+    attr_accessor :type
+
+    # @return [String] one of the values from {ENGINES}
+    attr_accessor :name
+
+    # @return [AgentOrange::Version]
+    attr_accessor :version
+
+    # @return [AgentOrange::Browser]
     attr_accessor :browser
 
     ENGINES = {
@@ -58,6 +67,7 @@ module AgentOrange
       AgentOrange.debug "", 2
     end
 
+    # @return [String]
     def to_s
       [self.name, self.version].compact.join(' ') || "Unknown"
     end

data/lib/agent_orange/operating_system.rb

@@ -2,7 +2,14 @@ require 'agent_orange/base'
 
 module AgentOrange
   class OperatingSystem < Base
-    attr_accessor :type, :name, :version
+    # @return [Symbol] one of the keys from {OPERATING_SYSTEMS}
+    attr_accessor :type
+
+    # @return [String] one of the values from {OPERATING_SYSTEM_NAMES}
+    attr_accessor :name
+
+    # @return [AgentOrange::Version]
+    attr_accessor :version
 
     OPERATING_SYSTEMS = {
       :android => 'android',
@@ -62,6 +69,7 @@ module AgentOrange
       AgentOrange.debug "", 2
     end
 
+    # @return [String]
     def to_s
       [self.name, self.version].compact.join(' ')
     end

data/lib/agent_orange/platform.rb

@@ -2,7 +2,14 @@ require 'agent_orange/base'
 
 module AgentOrange
   class Platform < Base
-    attr_accessor :type, :name, :version
+    # @return [Symbol] one of the keys from {PLATFORMS}
+    attr_accessor :type
+
+    # @return [String] one of the values from {PLATFORM_NAMES}
+    attr_accessor :name
+
+    # @return [AgentOrange::Version]
+    attr_accessor :version
 
     PLATFORMS = {
       :android => 'android',
@@ -17,6 +24,7 @@ module AgentOrange
       :mac => 'Macintosh',
       :pc => 'PC'
     }
+
     PLATFORM_VERSIONS = {
       :ipad => 'ipad',
       :iphone => 'iphone',

data/lib/agent_orange/user_agent.rb

@@ -5,10 +5,15 @@ module AgentOrange
   DEBUG_LEVEL = 1
 
   class UserAgent
+    # @return [String]
     attr_accessor :user_agent_string
+
     attr_accessor :user_language
+
+    # @return [AgentOrange::Device]
     attr_accessor :device
 
+    # @param [String] user_agent_string
     def initialize(user_agent_string)
       self.parse(user_agent_string)
     end
@@ -26,18 +31,22 @@ module AgentOrange
       self.summary
     end
 
+    # @return [Boolean]
     def is_computer?(type=nil)
       self.device.is_computer?(type)
     end
 
+    # @return [Boolean]
     def is_mobile?(type=nil)
       self.device.is_mobile?(type)
     end
 
+    # @return [Boolean]
     def is_bot?(type=nil)
       self.device.is_bot?(type)
     end
 
+    # @return [String]
     def to_s
       [self.device,
         self.device.platform,
@@ -47,6 +56,7 @@ module AgentOrange
         ].compact.join(", ")
     end
 
+    # @return [String]
     def to_human_string
       if self.device && self.device.engine && self.device.engine.browser
         "User has a #{self.device} running #{self.device.engine.browser} (which is based on #{self.device.engine})."

data/lib/agent_orange/version.rb

@@ -1,8 +1,18 @@
 module AgentOrange
-  VERSION = "0.1.4" # This is for the gem and does not conflict with the rest of the functionality
+  VERSION = "0.1.5" # This is for the gem and does not conflict with the rest of the functionality
 
   class Version
-    attr_accessor :major, :minor, :patch_level, :build_number
+    # @return [String, nil]
+    attr_accessor :major
+
+    # @return [String, nil]
+    attr_accessor :minor
+
+    # @return [String, nil]
+    attr_accessor :patch_level
+
+    # @return [String, nil]
+    attr_accessor :build_number
 
     def initialize(version_string)
       version_string = sanitize_version_string(version_string)
@@ -20,6 +30,7 @@ module AgentOrange
       self.build_number = pieces[3] if pieces_count >= 4
     end
 
+    # @return [String]
     def to_s
       [self.major, self.minor, self.patch_level, self.build_number].compact.join('.')
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: agent_orange
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-02 00:00:00.000000000 Z
+date: 2013-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -104,7 +104,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3447996973066074909
+      hash: 3187188624662308564
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -113,7 +113,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3447996973066074909
+      hash: 3187188624662308564
 requirements: []
 rubyforge_project: agent_orange
 rubygems_version: 1.8.24