cinch-toolbox 0.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
data/.gitignore ADDED
@@ -0,0 +1,17 @@
1
+ *.gem
2
+ *.rbc
3
+ .bundle
4
+ .config
5
+ .yardoc
6
+ Gemfile.lock
7
+ InstalledFiles
8
+ _yardoc
9
+ coverage
10
+ doc/
11
+ lib/bundler/man
12
+ pkg
13
+ rdoc
14
+ spec/reports
15
+ test/tmp
16
+ test/version_tmp
17
+ tmp
data/Gemfile ADDED
@@ -0,0 +1,4 @@
1
+ source 'https://rubygems.org'
2
+
3
+ # Specify your gem's dependencies in cinch-toolbox.gemspec
4
+ gemspec
data/LICENSE.txt ADDED
@@ -0,0 +1,22 @@
1
+ Copyright (c) 2013 Brian Haberer
2
+
3
+ MIT License
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining
6
+ a copy of this software and associated documentation files (the
7
+ "Software"), to deal in the Software without restriction, including
8
+ without limitation the rights to use, copy, modify, merge, publish,
9
+ distribute, sublicense, and/or sell copies of the Software, and to
10
+ permit persons to whom the Software is furnished to do so, subject to
11
+ the following conditions:
12
+
13
+ The above copyright notice and this permission notice shall be
14
+ included in all copies or substantial portions of the Software.
15
+
16
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17
+ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18
+ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
19
+ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
20
+ LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
21
+ OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
22
+ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,29 @@
1
+ # Cinch Toolbox
2
+
3
+ This is just a gem required fro many of my plugins, it facilitates a variety of mundane operations.
4
+
5
+ * URL Shortening / Expansion.
6
+ * Webpage DOM element retrieval (via xpath or css selectors).
7
+ * Output truncation for sanity proof channel output.
8
+
9
+ ## Installation
10
+
11
+ Add this line to your application's Gemfile:
12
+
13
+ gem 'cinch-toolbox'
14
+
15
+ And then execute:
16
+
17
+ $ bundle
18
+
19
+ Or install it yourself as:
20
+
21
+ $ gem install cinch-toolbox
22
+
23
+ ## Contributing
24
+
25
+ 1. Fork it
26
+ 2. Create your feature branch (`git checkout -b my-new-feature`)
27
+ 3. Commit your changes (`git commit -am 'Add some feature'`)
28
+ 4. Push to the branch (`git push origin my-new-feature`)
29
+ 5. Create new Pull Request
data/Rakefile ADDED
@@ -0,0 +1 @@
1
+ require "bundler/gem_tasks"
@@ -0,0 +1,22 @@
1
+ # -*- encoding: utf-8 -*-
2
+ lib = File.expand_path('../lib', __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require 'cinch-toolbox/version'
5
+
6
+ Gem::Specification.new do |gem|
7
+ gem.name = "cinch-toolbox"
8
+ gem.version = Cinch::Toolbox::VERSION
9
+ gem.authors = ["Brian Haberer"]
10
+ gem.email = ["bhaberer@gmail.com"]
11
+ gem.description = %q{A gem of various methods used in many of my plugins. If you need the namespace, let me know.}
12
+ gem.summary = %q{Common methods used in Cinch Plugins.}
13
+ gem.homepage = "https://github.com/bhaberer/cinch-toolbox"
14
+
15
+ gem.files = `git ls-files`.split($/)
16
+ gem.executables = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
17
+ gem.test_files = gem.files.grep(%r{^(test|spec|features)/})
18
+ gem.require_paths = ["lib"]
19
+
20
+ gem.add_dependency('nokogiri', '1.5.9')
21
+ gem.add_dependency('patron', '0.4.18')
22
+ end
@@ -0,0 +1,74 @@
1
+ # -*- coding: utf-8 -*-
2
+ require "cinch-toolbox/version"
3
+ require 'open-uri'
4
+ require 'patron'
5
+
6
+ module Toolbox
7
+
8
+ # Get an element of the supplied website
9
+ def Toolbox.get_html_element(url, selector, mode = 'css')
10
+ # Make sure the URL is legit
11
+ url = URI::extract(url, ["http", "https"]).first
12
+
13
+ case mode
14
+ when 'css'
15
+ return Nokogiri::HTML(open(url)).css(selector).first.content
16
+ when 'xpath'
17
+ return Nokogiri::HTML(open(url)).xpath(selector).first
18
+ end
19
+ end
20
+
21
+ # Expand a previously shortened URL via the configured shortener
22
+ def Toolbox.expand(url)
23
+ shortener.get("forward.php?format=simple&shorturl=#{url}").body
24
+ end
25
+
26
+ # Shorten a URL via the configured shortener
27
+ def Toolbox.shorten(url)
28
+ return url if url.length < 45
29
+ return shortener.get("create.php?format=simple&url=#{url}").body
30
+ end
31
+
32
+ # Truncate a given block of text, used for making sure the bot doesn't flood.
33
+ def Toolbox.truncate(text, length = 250)
34
+ text = text.gsub(/\n/, ' · ')
35
+ if text.length > length
36
+ text = text[0,length - 1] + '...'
37
+ end
38
+ return text
39
+ end
40
+
41
+ # Used to render a period of time in a uniform string.
42
+ # THere is probably a much better way to do this, so FIXME
43
+ def Toolbox.time_format(secs)
44
+ data = time_parse(secs)
45
+ string = ''
46
+
47
+ string << "#{data[:days]}d " unless data[:days].zero? && string == ''
48
+ string << "#{data[:hours]}h " unless data[:hours].zero? && string == ''
49
+ string << "#{data[:mins]}m " unless data[:mins].zero? && string == ''
50
+ string << "#{data[:secs]}s"
51
+
52
+ return string
53
+ end
54
+
55
+ def Toolbox.time_parse(secs)
56
+ days = secs / 86400
57
+ hours = (secs % 86400) / 3600
58
+ mins = (secs % 3600) / 60
59
+ secs = secs % 60
60
+
61
+ return { :days => days.floor,
62
+ :hours => hours.floor,
63
+ :mins => mins.floor,
64
+ :secs => secs.floor }
65
+ end
66
+
67
+ private
68
+
69
+ def Toolbox.shortener
70
+ short = Patron::Session.new
71
+ short.base_url = 'http://is.gd/'
72
+ return short
73
+ end
74
+ end
@@ -0,0 +1,5 @@
1
+ module Cinch
2
+ module Toolbox
3
+ VERSION = "0.0.1"
4
+ end
5
+ end
metadata ADDED
@@ -0,0 +1,86 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: cinch-toolbox
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.0.1
5
+ prerelease:
6
+ platform: ruby
7
+ authors:
8
+ - Brian Haberer
9
+ autorequire:
10
+ bindir: bin
11
+ cert_chain: []
12
+ date: 2013-05-01 00:00:00.000000000 Z
13
+ dependencies:
14
+ - !ruby/object:Gem::Dependency
15
+ name: nokogiri
16
+ requirement: !ruby/object:Gem::Requirement
17
+ none: false
18
+ requirements:
19
+ - - '='
20
+ - !ruby/object:Gem::Version
21
+ version: 1.5.9
22
+ type: :runtime
23
+ prerelease: false
24
+ version_requirements: !ruby/object:Gem::Requirement
25
+ none: false
26
+ requirements:
27
+ - - '='
28
+ - !ruby/object:Gem::Version
29
+ version: 1.5.9
30
+ - !ruby/object:Gem::Dependency
31
+ name: patron
32
+ requirement: !ruby/object:Gem::Requirement
33
+ none: false
34
+ requirements:
35
+ - - '='
36
+ - !ruby/object:Gem::Version
37
+ version: 0.4.18
38
+ type: :runtime
39
+ prerelease: false
40
+ version_requirements: !ruby/object:Gem::Requirement
41
+ none: false
42
+ requirements:
43
+ - - '='
44
+ - !ruby/object:Gem::Version
45
+ version: 0.4.18
46
+ description: A gem of various methods used in many of my plugins. If you need the
47
+ namespace, let me know.
48
+ email:
49
+ - bhaberer@gmail.com
50
+ executables: []
51
+ extensions: []
52
+ extra_rdoc_files: []
53
+ files:
54
+ - .gitignore
55
+ - Gemfile
56
+ - LICENSE.txt
57
+ - README.md
58
+ - Rakefile
59
+ - cinch-toolbox.gemspec
60
+ - lib/cinch-toolbox.rb
61
+ - lib/cinch-toolbox/version.rb
62
+ homepage: https://github.com/bhaberer/cinch-toolbox
63
+ licenses: []
64
+ post_install_message:
65
+ rdoc_options: []
66
+ require_paths:
67
+ - lib
68
+ required_ruby_version: !ruby/object:Gem::Requirement
69
+ none: false
70
+ requirements:
71
+ - - ! '>='
72
+ - !ruby/object:Gem::Version
73
+ version: '0'
74
+ required_rubygems_version: !ruby/object:Gem::Requirement
75
+ none: false
76
+ requirements:
77
+ - - ! '>='
78
+ - !ruby/object:Gem::Version
79
+ version: '0'
80
+ requirements: []
81
+ rubyforge_project:
82
+ rubygems_version: 1.8.24
83
+ signing_key:
84
+ specification_version: 3
85
+ summary: Common methods used in Cinch Plugins.
86
+ test_files: []