platformx 0.0.7 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ca7b6d2a7aac9298fc0c65283a38577ab965ba3c
-  data.tar.gz: 314d8db2ddb3a20ea50cfa92be604defb054cc93
+  metadata.gz: 571b39d3d6f2ebe74e27e2ac3254f32e62ac6beb
+  data.tar.gz: b834abaae3f5d33e7fcea76ca31bc5b5ba914023
 SHA512:
-  metadata.gz: 09aa0f8de9e457a5b7ab97657ba9d9261fe53bf67e7f51d88318a9068b48ec5c1894e1544a2fb0d1c417aab7e46932e72b2a6f8e1f773fb25c66379b15c4cdef
-  data.tar.gz: 322765572b038cb0c168a53fa788028b74dc5b055ab470a154545229b7880fcef371e3bcd3a12246f802a0ea215ff6e00abd8166c4fc117b1adb1ce75640acff
+  metadata.gz: d25f9bbcfd02967b288729cac8db60e17ecdf348fa81eec54bdfb7924ab646daf64df6afeab4b3e534cdf3985b828f12b0e027537c499de5a2c8704f73e65320
+  data.tar.gz: af66a07ab362239195187cc6d174c71df9606059f4a717e5b8a6cc4781ad8b3e9ef94bef73a9fff17375488728a077cdfa242b8cea9391a488e757650337e414

data/.gitignore

@@ -20,3 +20,6 @@ tmp
 *.o
 *.a
 mkmf.log
+
+.ruby-version
+.ruby-gemset

data/Gemfile

@@ -2,3 +2,7 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in platformx.gemspec
 gemspec
+
+group :development do
+  gem 'yard'
+end

data/README.md

@@ -28,4 +28,23 @@ To use in Sinatra add
 		config.bugsnag_api_key = "string"
 	end
 
-## Contributing
+## Documentation
+
+The gem is documented with YARD. You can run yard documentation using its inbuilt
+server. Following git clone...
+
+    ~# cd platformx-gem
+    ~# bundle install
+    ~# yard server --reload
+
+and visit localhost:8808.
+
+If you prefer to compile it to html (ex: to host)..
+
+    ~# yard
+
+For more information visit [yardoc website](http://yardoc.org/) or use...
+
+    ~# yard --help
+
+## Contributing

data/lib/platformx/auth.rb

@@ -1,74 +1,81 @@
 module Platformx
-	module AuthHelpers
-########################################################
-#
-# Start Helpers
-#
-########################################################
+  module AuthHelpers
 
-########################################################
-#
-# Admin Login 
-#
-########################################################
+    # Admin session helpers
 
-def x_admin_authorized?
-    session[:admin_authorized]
-end
+    # Checks if the current user authorizes as an admin
+    #
+    # @return [Boolean] if current user authorizes as an admin
+    def x_admin_authorized?
+      session[:admin_authorized]
+    end
 
-def x_admin_authorize!
-    redirect '/admin/login' unless x_admin_authorized? || request.url.include?("/admin/login")
-end
+    # Authorizes the current user as an admin or redirects the user to the admin login page.
+    def x_admin_authorize!
+      redirect '/admin/login' unless x_admin_authorized? || request.url.include?("/admin/login")
+    end
 
-def x_admin_logout!
-   session[:admin_authorized] = false
-   session.clear
-end
+    # Logs out the amdin
+    def x_admin_logout!
+      session[:admin_authorized] = false
+      session.clear
+    end
 
-########################################################
-#
-# Login 
-#
-########################################################
+    # User session helpers
 
-def x_authorized?
-    session[:authorized]
-end
+    # Checks if the user is logged in
+    #
+    # @return [Boolean] if uesr logged in
+    def x_authorized?
+      session[:authorized]
+    end
 
-def x_authorize!
-    redirect '/login' unless x_authorized? || request.url.include?("/login") || request.url.include?("/auth")
-end
+    # Authorizes the user and redirects the user to the registration page.
+    def x_authorize!
+      redirect '/login' unless x_authorized? || request.url.include?("/login") || request.url.include?("/auth")
+    end
 
-def x_logout!
-   session[:authorized] = false
-   session.clear
-end
+    # Logs out the currenly logged in user
+    def x_logout!
+       session[:authorized] = false
+       session.clear
+    end
 
-########################################################
-#
-# Encyrption
-#
-########################################################
-  def x_encrypt(int = "")
-  str = int.to_s
-    #encrypted_value = Encryptor.encrypt(:value => str, :key => "=PeuMX7B4LQ#@jG*s;tYGdF")
-    return Base64.urlsafe_encode64(str)
-  end
+    # Encyrption helprs
+    
+    # Encodes a value to a base 64 string.
+    #
+    # @note The provided object should respond to `#to_s` to obtain a string representation of the object.
+    #
+    # @param int [Object] the value required to be encrypted
+    #
+    # @return [String] encoded string
+    def x_encrypt(int = "")
+      str = int.to_s
+      #encrypted_value = Encryptor.encrypt(:value => str, :key => "=PeuMX7B4LQ#@jG*s;tYGdF")
+      return Base64.urlsafe_encode64(str)
+    end
 
-  def x_decrypt(str = "")
-    str = Base64.urlsafe_decode64(str)
-    #decrypted_value = Encryptor.decrypt(:value => str, :key => '=PeuMX7B4LQ#@jG*s;tYGdF')
-    return str.to_i
-  end
+    # Decodes an encoded string
+    #
+    # @param str [String] the encoded string
+    #
+    # @return [String] decoded string
+    def x_decrypt(str = "")
+      str = Base64.urlsafe_decode64(str)
+      #decrypted_value = Encryptor.decrypt(:value => str, :key => '=PeuMX7B4LQ#@jG*s;tYGdF')
+      return str.to_i
+    end
+
+    # Generate a random password
+    #
+    # @param len [Integer] the length of the password
+    #
+    # @return [String] random generated password
+    def x_generate_password(len = "10")
+      random_password = Array.new(len).map { (65 + rand(58)).chr }.join
+      return random_password
+    end
 
-  def x_generate_password(len = "10")
-    random_password = Array.new(len).map { (65 + rand(58)).chr }.join
-    return random_password
-  end
-########################################################
-#
-# End
-#
-########################################################
   end
-end
+end

data/lib/platformx/aws.rb

@@ -1,71 +1,71 @@
 module Platformx
-	module S3Helpers
-########################################################
-#
-# Set Up Connection
-#
-########################################################
-def x_s3_init()
-
-	connection = Fog::Storage.new({
-		:provider                 => 'AWS',
-		:region 									=> Platformx.configuration.aws_region,
-		:aws_access_key_id        => Platformx.configuration.aws_access_key_id,
-		:aws_secret_access_key    => Platformx.configuration.aws_secret_access_key
-		})
-	return connection
-
-end
-
-########################################################
-#
-# Upload to S3
-#
-########################################################
-def x_s3_upload(new_filename: "", file: "", bucket: "#{Platformx.configuration.aws_bucket}", path: "")
-
-
-################# Init S3 #################
-connection = x_s3_init
 
+  #
+  # Amazon S3 helpers
+  #
+  # @author Tim Mushen
+  #
+  module S3Helpers
+ 
+    # Set up Amazon S3 connection
+    # 
+    # @return [Fog::Storage] S3 storage connection
+    def x_s3_init()
+      connection = Fog::Storage.new({
+        :provider                 => 'AWS',
+        :region                   => Platformx.configuration.aws_region,
+        :aws_access_key_id        => Platformx.configuration.aws_access_key_id,
+        :aws_secret_access_key    => Platformx.configuration.aws_secret_access_key
+      })
+      return connection
+    end
 
-################# Set Bucket #################
-bucket = connection.directories.create(key: "#{bucket}/#{path}", public: false)
+    # Upload file to S3 with the given parameters
+    #
+    # @param new_filename [String] new name of the file
+    # @param file [String] file to be uploaded
+    # @param bucket [String] bucket to upload the file to
+    # @param path [String] path of the final file
+    #
+    # @return S3 bucket file
+    def x_s3_upload(new_filename: "", file: "", bucket: "#{Platformx.configuration.aws_bucket}", path: "")
+      # Obtaining an S3 connection
+      connection = x_s3_init
 
-# upload that resume
-file = bucket.files.create(
-	:key    => "#{new_filename}",
-	:body   => open(file),
-	:public => false
-	)
+      # Creating the directory to upload the file to
+      bucket = connection.directories.create(key: "#{bucket}/#{path}", public: false)
 
-end
+      # upload that resume
+      file = bucket.files.create(
+        :key    => "#{new_filename}",
+        :body   => open(file),
+        :public => false
+      )
+    end
 
+    # Download link from S3 asset
+    #
+    # @param key [String] key or the file name
+    # @param bucket [String] the bucket name
+    # @param bucket_path [String] the bucket path
+    # @param verbose [Boolean] make operation verborse
+    #
+    # @return [String] a public URL for the file
+    #
+    # @note The returned public URL will expire in 7 days
+    def x_s3_get_link(key: "", bucket: "", bucket_path: "", verbose: false)
+      
+      connection = x_s3_init
+      expiry = Time.now.to_i + 604800
+      connection.directories.new(:key => "#{bucket}").files.new(:key => "#{bucket_path}/#{key}").url(expiry)
+     
+      if verbose == true
+        # returns more information about file from s3
+        # directory = connection.directories.get("files.myclocktower.com")
+        # file = directory.files.get("support/#{support_id}/#{key}")
+        #return file.url(expiry)
+      end 
+    end
 
-########################################################
-#
-# Download from S3
-#
-########################################################
-def x_s3_get_link(key: "", bucket:"", bucket_path:"", verbose: false)
-	
-  connection = x_s3_init
-  expiry = Time.now.to_i + 604800
-  connection.directories.new(:key => "#{bucket}").files.new(:key => "#{bucket_path}/#{key}").url(expiry)
- 
- 	if verbose == true
-  # returns more information about file from s3
-  # directory = connection.directories.get("files.myclocktower.com")
-  # file = directory.files.get("support/#{support_id}/#{key}")
-  #return file.url(expiry)
-	end
- 
+  end
 end
-
-########################################################
-#
-# End
-#
-########################################################
-	end
-end

data/lib/platformx/date.rb

@@ -1,96 +1,99 @@
 module Platformx
-	module DateHelpers
-########################################################
-#
-# Start Helpers
-#
-########################################################
 
-########################################################
-#
-# Time in words
-#
-########################################################
-def x_time_in_words(date: "")
-    date = date.to_date
-    date = Date.parse(date, true) unless /Date.*/ =~ date.class.to_s
-    days = (date - Date.today).to_i
-    return 'Today' if days >= 0 and days < 1
-    return 'Tomorrow' if days >= 1 and days < 2
-    return 'Yesterday' if days >= -1 and days < 0
-    return "In #{days} days" if days.abs < 60 and days > 0
-    return "#{days.abs} days ago" if days.abs < 60 and days < 0
-    return date.strftime('%A, %B %e, %Y') if days.abs < 182
-    return date.strftime('%A, %B %e, %Y')
-end
+  #
+  # Date helpers module
+  # @author Tim Mushen
+  #
+  module DateHelpers
 
-########################################################
-#
-# Returns relative time in words referencing the given date
-# relative_time_ago(Time.now) => 'about a minute ago'
-#
-########################################################
-def x_relative_time_ago(from_time: "")
-    distance_in_minutes = (((Time.now - from_time.to_time).abs)/60).round
-    case distance_in_minutes
-    when 0..1 then 'A minute ago'
-    when 2..44 then "#{distance_in_minutes} minutes ago"
-    when 45..89 then '1 hour ago'
-    when 90..1439 then "#{(distance_in_minutes.to_f / 60.0).round} hours ago"
-    when 1440..2439 then '1 day ago'
-    when 2440..2879 then '2 days ago'
-    when 2880..43199 then "#{(distance_in_minutes / 1440).round} days ago"
-    when 43200..86399 then 'About 1 month ago'
-    when 86400..525599 then "#{(distance_in_minutes / 43200).round} months ago"
-    when 525600..1051199 then 'About 1 year ago'
-    else "Over #{(distance_in_minutes / 525600).round} years ago"
+    # Get the time in words
+    # @param date [String] a string representation of the date
+    # @return [String] time in words
+    def x_time_in_words(date: "")
+        date = date.to_date
+        date = Date.parse(date, true) unless /Date.*/ =~ date.class.to_s
+        days = (date - Date.today).to_i
+        return 'Today' if days >= 0 and days < 1
+        return 'Tomorrow' if days >= 1 and days < 2
+        return 'Yesterday' if days >= -1 and days < 0
+        return "In #{days} days" if days.abs < 60 and days > 0
+        return "#{days.abs} days ago" if days.abs < 60 and days < 0
+        return date.strftime('%A, %B %e, %Y') if days.abs < 182
+        return date.strftime('%A, %B %e, %Y')
     end
-end
 
-def x_format_date(date: "", show_time: false, show_month: true)
-    
-    
-    if date.nil?
+    # Returns relative time in words referencing the given date
+    # @param from_time [Time] the from time
+    # @return [String] a 'time ago' representation for the given time
+    # @example
+    #   relative_time_ago(Time.now) # => 'about a minute ago'
+    def x_relative_time_ago(from_time: "")
+      distance_in_minutes = (((Time.now - from_time.to_time).abs)/60).round
+
+      case distance_in_minutes
+      when 0..1 then 'A minute ago'
+      when 2..44 then "#{distance_in_minutes} minutes ago"
+      when 45..89 then '1 hour ago'
+      when 90..1439 then "#{(distance_in_minutes.to_f / 60.0).round} hours ago"
+      when 1440..2439 then '1 day ago'
+      when 2440..2879 then '2 days ago'
+      when 2880..43199 then "#{(distance_in_minutes / 1440).round} days ago"
+      when 43200..86399 then 'About 1 month ago'
+      when 86400..525599 then "#{(distance_in_minutes / 43200).round} months ago"
+      when 525600..1051199 then 'About 1 year ago'
+      else "Over #{(distance_in_minutes / 525600).round} years ago"
+      end
+    end
+
+    # Formats the date
+    # @param date [Time] date representation in the format %A, %B %d, %Y
+    # @param show_time [Boolean] if the timme should be incldued
+    # @param show_month [Boolean] if teh month should be included
+    # @return [String] formated representation of the given date
+    def x_format_date(date: "", show_time: false, show_month: true)    
+      if date.nil?
         return ""
-    else
+      else
         time = date.strftime("%A, %B %d, %Y")
     
         if show_time == true
-            time = time + date.strftime(" %l:%M %p")
+          time = time + date.strftime(" %l:%M %p")
         end
         
         return time
+      end
     end
-end
 
-def x_format_datetime(date: "")
-    
-    if date.nil?
+    # Format date time
+    # @param date [Time] the date-time to be formatted
+    # @return [String] the formatted date
+    def x_format_datetime(date: "") 
+      if date.nil?
         return ""
-    else
+      else
         time = date.strftime("%A, %B %d, %Y %l:%M %p")
         return time
+      end
     end
-end
 
-def x_format_time(time: "")
-    
-    if time.nil?
+    # Format time
+    # @param time [Time] the time to be formatted
+    # @return [String] formatted time
+    def x_format_time(time: "")
+      if time.nil?
         return ""
-    else
+      else
         time = time.strftime("%l:%M %p")
         return time
+      end
     end
-end
 
-def x_short_date(datevar: "")
-    return datevar.strftime("%A, %-m-%d-%y") unless datevar.nil?
-end
+    # Short date with format %A, %-m-%d-%y
+    # @param datevar [Time | Date] date or time to be formatted
+    # @return [String] formatted date/time
+    def x_short_date(datevar: "")
+      return datevar.strftime("%A, %-m-%d-%y") unless datevar.nil?
+    end
 
-########################################################
-#
-# End
-#
-########################################################
   end
-end
+end