platformx 0.0.7 → 0.0.8

data/lib/platformx/layout.rb

@@ -1,15 +1,12 @@
 module Platformx
+  # Layout helpers
+  # @author Tim Mushen
 	module LayoutHelpers
-########################################################
-#
-# Start Helpers
-#
-########################################################
-########################################################
-#
-# Panel
-#
-########################################################
+
+# Panel top view helper
+# @param title [String] the title of the panel
+# @param panel_class [String] the panel html classes
+# @return [String] rendered panel top html
 def x_panel_top(title: "", panel_class: "")
 if title != ""
 title=<<EOS
@@ -26,6 +23,8 @@ EOS
 	return panel
 end
 
+# Panel bttom view helper
+# @return [String] rendered panel bottom html
 def x_panel_bottom
 panel =<<EOS
 	</div>
@@ -34,11 +33,13 @@ EOS
 	return panel
 end
 
-########################################################
-#
-# Card
-#
-########################################################
+# Card (top) view helper
+# @param title [String] title of the card
+# @param subtitle [String] subtitle of the card
+# @param card_class [String] card html classes
+# @param header_css [String] header css of the card
+# @param buttons [String] card buttons
+# @return [String] rendered card top html
 def x_card_top(title: "",subtitle: "", card_class: "", header_css: "", buttons: "")
 if title != ""
 title=<<EOS
@@ -58,6 +59,8 @@ EOS
 	return panel
 end
 
+# Card (bottom) view helper
+# @return [String] rendered card bottom html
 def x_card_bottom
 panel =<<EOS
 	</div>
@@ -66,12 +69,9 @@ EOS
 	return panel
 end
 
-########################################################
-#
-# Gravitar
-#
-########################################################
-
+# Gravitar view helper
+# @param email [String] email of the user to show the garvitar
+# @return [String] gravitar image uri
 def x_gravitar(email: "")
 	hash = ""
 	
@@ -88,11 +88,10 @@ def x_gravitar(email: "")
 	return image_src
 end
 
-########################################################
-#
 # Student Tabs Nav
-#
-########################################################
+# @param active [String] tab active
+# @param tabs [Array] array of tabs
+# @return [String] rendered tabs navigation
 def x_tabs(active: "", tabs: array)
 
 tab_builder = ""
@@ -124,11 +123,11 @@ return tab_wrapper
 end
 
 
-########################################################
-#
 # Dashboard Number Widget
-#
-########################################################
+# @param label [String] number widget label
+# @param value [String] number widget value
+# @param icon [String] number widget icon
+# @return [String] rendered number widget
 def x_number_widget(label: "", value: "", icon: "")
 
 icon_html = ""
@@ -146,10 +145,5 @@ EOS
 return widget
 
 end
-########################################################
-#
-# End
-#
-########################################################
   end
-end
+end

data/lib/platformx/mail.rb

@@ -1,11 +1,9 @@
 module Platformx
+  # Mail module
+  # @author Tim Mushen
 	module Mail
 
-########################################################
-#
-# Conig
-#
-########################################################
+# Conig mail
 def self.init
     #Pony Configs
      Pony.options = { 
@@ -24,11 +22,10 @@ def self.init
     }
 end
 
-########################################################
-#
-# Mail
-#
-########################################################
+# Send mail
+# @param to [String] to addresses
+# @param cc [String] cc addresses
+# @param html_body [String] body of the message (in html)
 def self.mail(to: "", cc: "", subject: "", html_body: "")
     init
     Pony.mail(
@@ -40,4 +37,4 @@ def self.mail(to: "", cc: "", subject: "", html_body: "")
 end
 
     end
-end
+end

data/lib/platformx/notify.rb

@@ -1,10 +1,15 @@
 module Platformx
+
+  # Notification helpers
+  # @author Tim Mushen
 	module NotifyHelpers
-########################################################
-#
-# Start Helpers
-#
-########################################################
+
+# Notify view helper
+# @param flash [Object] flash object
+# @param timer [Integer] the length the notify should show
+# @param align [String] the alignment of the notify (left or right)
+# @param from [String] the location of the notify
+# @return [String] rendered notify message (js script)
 def x_notify(flash: "", timer: 4000, align: "right", from:"top")
 
 color = "success"
@@ -35,11 +40,5 @@ return cb
 end
 end
 
-
-########################################################
-#
-# End
-#
-########################################################
   end
-end
+end

data/lib/platformx/omniauth_helpers.rb

@@ -1,4 +1,6 @@
 module Platformx
+  # Omniauth helpers
+  # @author Tim Mushen
 	module OmniauthHelpers
 ########################################################
 #
@@ -13,4 +15,4 @@ module Platformx
 #
 ########################################################
   end
-end
+end

data/lib/platformx/omniauth_routes.rb

@@ -1,12 +1,13 @@
 module Platformx
+
+  # Omniauth routes
+  # @author Tim Mushen
 	module OmniauthRoutes
 
+    # Register routes for OmniAuth with Sinatra app
+    # @todo add individual route documentation. yard-sinatra plugin is not detecting these
+    #   routes. Probably because of the app.get format.
 		def self.registered(app)
-########################################################
-#
-# Start Method
-#
-######################################################## 
 
 app.get '/omniauth-test/?' do
 	"Yes!" 
@@ -54,11 +55,6 @@ app.get '/logout' do
 	redirect '/'
 end
 
-########################################################
-#
-# End Methods
-#
-########################################################
 		end  
 	end
-end
+end

data/lib/platformx/pdf.rb

@@ -1,14 +1,16 @@
 module Platformx
+  
+  # PDF helpers module
+  # @author Tim Mushen
 	module PdfHelpers
-########################################################
-#
-# PDF's
-#
-########################################################
 
-
-
-################# Fill PDF #################
+    # Fill pdf helper
+    # @todo Figure out what this method does and returns
+    # @param source_pdf [String] source pdf
+    # @param target_file_path [String] target file path
+    # @param new_pdf_name [String] new name of the pdf
+    # @param pdf_variables [String] pdf variables
+    # @param flatten [String] if to flatten or not 
 def x_fill_pdf(source_pdf: "", target_file_path: "", new_pdf_name: "", pdf_variables: {}, flatten: true)
 	# include pdftk
 	pdftk = PdfForms.new(settings.pdftk_path)
@@ -28,15 +30,5 @@ def x_fill_pdf(source_pdf: "", target_file_path: "", new_pdf_name: "", pdf_varia
 		:flatten => flatten
 end
 
-
-
-
-
-
-########################################################
-#
-# End Class
-#
-########################################################
 	end
-end
+end

data/lib/platformx/stripe.rb

@@ -1,43 +1,57 @@
 module Platformx
+  # Stripe helpers module
+  # @author Tim Mushen
 	module StripeHelpers
 	require "active_support/all"
-########################################################
-#
-# Start Helpers
-#
-########################################################
+
+# Provide all stripe invoices
+# @param customer_id [String] stripe customer id
+# @return [Array<Stripe::Invoice>] collection of stripe invoices
 def x_stripe_invoices(customer_id: "")
 	invoices = Stripe::Invoice.all
 	return invoices
 end
 
+# Get specific stripe invoice
+# @param invoice [String] stripe invoice id
+# @return [Stripe::Invoice] the stripe invoice identified by id
 def x_stripe_invoice(invoice: "")
 	invoice = Stripe::Invoice.retrieve(invoice)
 	return invoice
 end
 
+# Get stripe customer
+# @param customer_id [String] stripe customer id
+# @return [Stripe::Customer] stripe customer identified by id
 def x_stripe_customer(customer_id: "")
 	customer = Stripe::Customer.retrieve(customer_id)
 	return customer
 end
 
+# Retrieve stripe card for a customer
+# @param customer_id [String] stripe customer id
+# @param card_id [String] stripe card id
+# @return [Stripe::Card] stripe card
 def x_stripe_customer_card(customer_id: "", card_id: "")
 	customer = Stripe::Customer.retrieve(customer_id)
 	card = customer.sources.retrieve(card_id)
 	return card
 end
 
+# Delete a stripe card for a customer
+# @param customer_id [String] stripe customer id
+# @param card_id [String] stripe card id
+# @return [Stripe::Card] stripe card which was deleted
 def x_stripe_customer_card_delete(customer_id: "", card_id: "")
 	customer = Stripe::Customer.retrieve(customer_id)
 	card = customer.sources.retrieve(card_id).delete()
 	return card
 end
 
-########################################################
-#
-# Common functions for Stripe
-#
-########################################################
+# Stripe total including tax
+# @param amount [Numeric] amount
+# @param tax_percentage [Numeric] tax percentage
+# @return [String] stripe total including tax if included
 def x_stripe_total(amount: "", tax_percentage: "")
 		num = 0
 
@@ -55,11 +69,5 @@ def x_stripe_total(amount: "", tax_percentage: "")
 
 end
 
-
-########################################################
-#
-# End
-#
-########################################################
   end
-end
+end

data/lib/platformx/text.rb

@@ -1,17 +1,22 @@
 module Platformx
+  # Text helpers module
+  # @author Tim Mushen
 	module TextHelpers
-########################################################
-#
-# Start Helpers
-#
-########################################################
 
-# Slug
+# Generates slug from text
+# @param slug [String] text to slug
+# @return [String] slugged text
 def x_slug(slug: "")
   return slug.slugify
 end
 
-#x_boolean_label
+# Generate boolean label
+# @param value [Boolean] boolean value
+# @param type [String] boolean label type
+# @return [String] boolean label (yes or no for boolean value)
+# @example
+#   x_boolean_label(true) # -> "Yes"
+#   x_boolean_label(false) # -> "No"
 def x_boolean_label(value: "", type: "text")
 
 	if !value.nil? && value == true
@@ -23,10 +28,6 @@ def x_boolean_label(value: "", type: "text")
 	return str
 
 end
-########################################################
-#
-# End
-#
-########################################################
+
   end
-end
+end

data/lib/platformx/version.rb

@@ -1,3 +1,3 @@
 module Platformx
-  VERSION = "0.0.7"
+  VERSION = "0.0.8"
 end

data/lib/platformx.rb

@@ -1,3 +1,4 @@
+# PlatformX - gems
 require "platformx/version"
 require "platformx/auth"
 require "platformx/form"
@@ -11,7 +12,7 @@ require "platformx/pdf"
 require "platformx/text"
 require "platformx/aws"
 
-###########################  Require Gems  ############################
+# 3rd party gems
 require "sinatra/base"
 require "sinatra/contrib/all"
 require "sinatra/partial"
@@ -42,41 +43,93 @@ require "fog"
 module Platformx
 
   class << self
+    # Controls the app configuration
+    # @return [Platformx::Configuration] configuration object
     attr_accessor :configuration
   end
 
+  # Configure the PlatformX gem
+  #
+  # @example
+  #   Platformxe.confgure do |config|
+  #     config.bugsnag_api_key = "XYZ"
+  #     
+  #     config.mail_from = "John Doe"
+  #     config.mail_address = "johndoe@example.com"
+  #     config.mail_port = "578"
+  #     config.mail_domain = "smtp.mailgun.org"
+  #     config.mail_user_name = ""
+  #     config.mail_password = ""
+  #     config.mail_authentication = "plain"
+  #
+  #     config.aws_bucket = ""
+  #     config.aws_access_key_id = ""
+  #     config.aws_secret_access_key = ""
+  #     config.aws_region = ""
+  #   end
   def self.configure
     self.configuration ||= Configuration.new
     yield(configuration)
   end
 
-########################################################
-#
-# Start Configuration Class
-#
-########################################################
+  #
+  # PlatformX configuration class.
+  #
+  # @author Tim Mushen
+  #
   class Configuration
 
- 		# For Bugsnag
+    # Controls the bugsnag api key attribute
+    # @return [String] Bugsnag api key
     attr_accessor :bugsnag_api_key
 
-    # X_mail
+    # Controls the mail from
+    # @return [String] the mail from
     attr_accessor :mail_from
+
+    # Controls the mail address
+    # @return [String] the mail address
     attr_accessor :mail_address
+
+    # Controls the mail port number
+    # @return [String] the mail port number
     attr_accessor :mail_port
+    
+    # Controls the mail domain
+    # @return [String] the mail domain
     attr_accessor :mail_domain
+    
+    # Controls the mail user name
+    # @return [String] the mail user name
     attr_accessor :mail_user_name
+    
+    # Controls the mail password
+    # @return [String] the mail password
     attr_accessor :mail_password
+    
+    # Controls mail authentication 
+    # @return [String] mail authentication
     attr_accessor :mail_authentication
-
-    # For AWS/Fog
+ 
+    # Controls the aws bucket name
+    # @return [String] aws bucket name
     attr_accessor :aws_bucket
+    
+    # Controls the aws access key id
+    # @return [String] the aws access key id
     attr_accessor :aws_access_key_id
+    
+    # Controls the aws secret access key
+    # @return [String] the aws secret access key
     attr_accessor :aws_secret_access_key
+    
+    # Controls the aws region
+    # @return [String] aws region
     attr_accessor :aws_region
 
+    # Initialize Platformx configuration object and set defaults
     def initialize
-      # Bugsnag:
+      # Bugsnag
       @bugsnag_api_key = ""
       
       # X_mail
@@ -98,54 +151,46 @@ module Platformx
   end
 
 
-
-
-########################################################
-#
-# Start Sinatra Module
-#
-########################################################
-
+  # Platformx - Sinatra module
   module Sinatra
 
-  	def self.registered(app)
-			app.helpers Platformx::DateHelpers
-			app.helpers Platformx::StripeHelpers
-			app.helpers Platformx::AuthHelpers
-			app.helpers Platformx::FormHelpers
-			app.helpers Platformx::LayoutHelpers
-			app.helpers Platformx::NotifyHelpers
-			app.helpers Platformx::FakerHelpers  
-			app.helpers Platformx::TextHelpers 
-			app.helpers Platformx::PdfHelpers
-			app.helpers Platformx::S3Helpers
-		
+    def self.registered(app)
+      app.helpers Platformx::DateHelpers
+      app.helpers Platformx::StripeHelpers
+      app.helpers Platformx::AuthHelpers
+      app.helpers Platformx::FormHelpers
+      app.helpers Platformx::LayoutHelpers
+      app.helpers Platformx::NotifyHelpers
+      app.helpers Platformx::FakerHelpers  
+      app.helpers Platformx::TextHelpers 
+      app.helpers Platformx::PdfHelpers
+      app.helpers Platformx::S3Helpers
+    
       # #BugSnag
       # if Platformx.configuration.bugsnag_api_key != ""
-      # 	app.Bugsnag.configure do |config|
-      #  		 config.api_key = Platformx.configuration.bugsnag_api_key
-      # 	end
-      # 	app.use Bugsnag::Rack
-      # 			app.enable :raise_errors
+      #   app.Bugsnag.configure do |config|
+      #       config.api_key = Platformx.configuration.bugsnag_api_key
+      #   end
+      #   app.use Bugsnag::Rack
+      #       app.enable :raise_errors
       # end
 
+      # Configure Better Errors
+      if app.development?
+        app.use BetterErrors::Middleware
+          BetterErrors.application_root = __dir__
+      end
 
-		# Configure Better Errors
-		if app.development?
-			app.use BetterErrors::Middleware
-  			BetterErrors.application_root = __dir__
-		end
-
-		# Configure Rack Protection
-		if app.production?
-			app.use Rack::Protection
-		end
-		
-  	end
+      # Configure Rack Protection
+      if app.production?
+        app.use Rack::Protection
+      end 
+    end
 
   end # End Sinatra
 end
+
 #Register Helpers
 Sinatra.register Platformx::Sinatra
 Sinatra.register Sinatra::Numeric
-Sinatra.register Sinatra::HtmlHelpers
+Sinatra.register Sinatra::HtmlHelpers

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: platformx
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors:
 - timmushen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-21 00:00:00.000000000 Z
+date: 2017-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler