national_day_list 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a4f0191a0d59500fb0fa9d2775d984cf265c12b1
+  data.tar.gz: 0c96fef51af4be800a46d7140f0655c62dd077d0
+SHA512:
+  metadata.gz: 7d4062496798b0c38a334f0f2ea5c2ce077ef7ec305f0fe7e7562e3ea647a8c464379d62a6d2e2103cc5e4e65bfbbd675e394cea30843a81a60162c25b27df47
+  data.tar.gz: 6f77acbdfb55dfc875eeb79ee7257bba824afcfabb45c464774378574e1d57d13e7c279cf900e6307373d8503f8b2c32ff408af55a51b9512572c6640039c047

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Patrick Sattelberger
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,61 @@
+# National Day List
+A simple api & cli for getting a list of national days from 'www.nationaldaycalendar.com'.
+
+## Dependencies
+* Ruby
+* Ruby gems
+
+*Ruby dev may also be required*
+
+## Installation
+
+	gem install national_day_list
+
+## Running
+	nationaldaylist
+
+## Api Usage
+
+	require 'nationaldaylist'
+
+	#Create the api with caching
+	api = NationalDayList.new
+	#Create the api without caching
+	api = NationalDayList.new(false)
+
+	#Get a month. You can alse specify its number ("3") or index (2)
+	month = api.get_month("march")
+
+	#Returns true if the month is cached, teks the same perameters as #get_month
+	cached = api.cached?("march")
+
+	#get_month will cache the month when called and return the cached data if available
+	#Clear the cache
+	api.clear_cache()
+
+	#Get the first day of the month
+	day = month[0]
+	#Get a readable title from the day
+	title = day.title
+
+	#Get the first national day at this date
+	nday = day.days[0]
+	#get National Day name
+	nday_name = nday.name
+	#Get summary
+	#Fetch details if we don't already have them
+	nday.add_details unless nday.has_details
+	nday_summary = nday.summary
+
+## Contributing
+Pull requests welcome
+* Try to follow existing coding styles and patterns.
+* Write new tests for new api changes (Adding information or features).
+* Make sure all tests pass before submitting.
+
+If you have questions or feedback you can contact me at sattelbergerp@gmail.com. 
+*Yes I used two spaces for indentation; no I don't like it either.*
+
+## License
+MIT
+See LICENSE.txt

data/bin/nationaldaylist

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require 'nationaldaylist'
+
+CLI.new.run

data/config/enviroment.rb

@@ -0,0 +1,9 @@
+require 'bundler'
+require 'open-uri'
+require 'nokogiri'
+require 'colorize'
+require 'launchy'
+require 'require_all'
+Bundler.require
+
+require_all 'lib'

data/lib/cli.rb

@@ -0,0 +1,110 @@
+require_relative '../config/enviroment'
+
+class CLI
+
+	MONTHS= ["january", "february", "march", "april", "may", "june", "july", "august", "september", "october", "november", "december"]
+
+	attr_reader :api
+
+	def initialize()
+		@cache = {}
+		@api = NationalDayList.new()
+	end
+
+	def run
+		puts "CLI for 'www.nationaldaycalendar.com'. Type 'help' for usage."
+		loop do
+			print '>'
+			cmd = gets.chomp.split(" ")
+			case cmd[0]
+			when "exit"
+				return;
+			when "today"
+				date = Date.today
+				parseDateCommand([date.month.to_s, date.mday.to_s] + cmd[1..-1])
+			when 'help'
+				puts "Type '1' or 'january' to view all national days for january."
+				puts "Type '1 2' or 'january' first to view all national days for january second."
+				puts "Type '1 2 4' to view the fourth national day for january second."
+				puts "Month and day of month can be replaced with 'today' in all commands."
+				puts "Type 'exit' to exit"
+			else
+				parseDateCommand(cmd);
+			end
+		end
+	end
+
+	private
+	def parseDateCommand(cmd)
+		puts "Loading Month Information..." unless api.cached?(cmd[0])
+		month = api.get_month(cmd[0])
+		if month
+			if cmd.count > 1
+				parseDayCommand(cmd, month)
+			else
+				month.count.times {|index| printDay(month[index], cmd[0], index+1)}
+			end
+		else
+			puts "Unknown month or command".colorize(:light_red)
+		end
+	end
+
+	def parseDayCommand(cmd, month)
+		day_index = cmd[1].to_i-1
+		day = month[day_index]
+		if day && day_index > -1
+			if cmd.count>2
+				parseDayDetailsCommand(cmd, month, day)
+			else
+				printDay(day, cmd[0], cmd[1])
+			end
+		else
+			puts "Could not find day in month".colorize(:light_red)
+		end
+	end
+
+	def parseDayDetailsCommand(cmd, month, day)
+		nday_index = cmd[2].to_i-1
+		nday = day.days[nday_index]
+		if nday && nday_index>-1
+			if cmd.count > 3
+				parseDayOperationCommand(nday, cmd)
+			else
+				printDayDetails(nday, cmd[0], cmd[1], cmd[2])
+			end
+		else
+			puts "Can't find national day on specified date".colorize(:light_red)
+		end
+	end
+
+	def parseDayOperationCommand(nday, cmd)
+		case cmd[3]
+		when "open"
+			Launchy.open(nday.url)
+		else
+			puts "Unknown command for national day".colorize(:light_red)
+		end
+	end
+
+	#takes a day of month
+	def printDay(day_of_month, month_name, day_name)
+		puts "#{day_of_month.title}".colorize(:light_yellow)
+		day_of_month.days.each_with_index do |nday, index|
+			puts "	#{month_name} #{day_name} #{index+1}".colorize(:light_blue)+". #{nday.name}"
+		end
+		puts ""
+	end
+
+	def printDayDetails(national_day, month_name, day_name, nday_name)
+		if !national_day.has_details
+			puts "Loading National Day Information..."
+			national_day.add_details
+		end
+		puts "#{national_day.url}"
+		puts "#{national_day.name}".colorize(:light_yellow)
+		puts "#{national_day.summary}" if national_day.summary!=nil && !national_day.summary.empty?
+		puts ""
+		puts "Type '#{month_name} #{day_name} #{nday_name} open' to view in your default browser."
+	end
+
+end

data/lib/dayofmonth.rb

@@ -0,0 +1,18 @@
+class DayOfMonth
+	attr_accessor :title, :days
+
+	#utility method to take the array of hashes returned by the scraper and turn them into instances of this object
+	def self.array_from_hash_array(hash_array)
+		hash_array.collect {|hash|
+			self.new(hash)
+		}
+	end
+
+	def initialize(hash)
+		hash.each do |k,v|
+			self.send("#{k}=",v)
+		end
+		@days = @days.collect {|day| NationalDay.new(day)}
+	end
+
+end

data/lib/nationaldaylist.rb

@@ -0,0 +1,44 @@
+require_relative '../config/enviroment'
+
+class NationalDayList
+
+	attr_accessor :use_cache
+	MONTHS ||= ["january", "february", "march", "april", "may", "june", "july", "august", "september", "october", "november", "december"]
+	URL_BASE ||= "http://www.nationaldaycalendar.com/"
+	VERSION ||= '1.0.1'
+
+	def initialize(use_cache=true)
+		@use_cache = use_cache
+		@cache = {}
+	end
+
+	def get_month(input)
+		id = get_month_id(input)
+		month = @cache[id] if use_cache
+		month = DayOfMonth.array_from_hash_array(Scraper.scrape_month("#{URL_BASE}#{id}/")) if @cache[id]==nil || !use_cache
+		@cache[id] = month if use_cache
+		month
+	end
+
+	def cached?(input)
+		@cache[get_month_id(input)]!=nil&&use_cache
+	end
+
+	def clear_cache
+		@cache = {}
+	end
+
+	private
+	def get_month_id(input)
+		index = get_month_index(input)
+		return MONTHS[index] unless index < 0
+		nil
+	end
+
+	def get_month_index(input)
+		return input if input.class==Fixnum
+		return input.to_i()-1 unless input.to_i()==0
+		MONTHS.find_index(input.downcase)
+	end
+
+end

data/lib/scraper.rb

@@ -0,0 +1,35 @@
+
+class Scraper
+
+	#Used in openuri requests to prevent 403
+	#Coppied from chrome on windows 10
+	USER_AGENT = "Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/56.0.2924.87 Safari/537.36"
+
+	def self.scrape_month(full_url)
+		doc = Nokogiri::HTML(open(full_url, 'User-Agent'=>USER_AGENT))
+		days_of_month = []
+		tiles = doc.css('div.et_pb_blurb_container')
+		tiles.each do |tile|
+			day_of_month = {}
+			day_of_month[:title] = tile.css('h4').text
+			day_of_month[:days] = tile.css('li a').collect do |day_link|
+				{name: day_link.text, url: day_link.attr('href')}
+			end
+			days_of_month << day_of_month
+		end
+		days_of_month
+	end
+
+	def self.scrape_day_details(full_url)
+		doc = Nokogiri::HTML(open(full_url, 'User-Agent'=>USER_AGENT))
+		details = {}
+		doc.css(".post-content > p").each do |item|
+			if !item.text.strip.empty?
+				details[:summary] = item.text.gsub("\u00A0", ' ')
+				break
+			end
+		end
+		details
+	end
+
+end

metadata

@@ -0,0 +1,150 @@
+--- !ruby/object:Gem::Specification
+name: national_day_list
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Patrick Sattelberger
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-03-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.7.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.7.0.1
+- !ruby/object:Gem::Dependency
+  name: require_all
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: launchy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email: sattelbergerp@gmail.com
+executables:
+- nationaldaylist
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- bin/nationaldaylist
+- config/enviroment.rb
+- lib/cli.rb
+- lib/dayofmonth.rb
+- lib/nationaldaylist.rb
+- lib/scraper.rb
+homepage: https://github.com/sattelbergerp/national-day-list
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.2
+signing_key: 
+specification_version: 4
+summary: A simple api & cli for getting a list of national days from 'www.nationaldaycalendar.com'.
+test_files: []