Project

kktix_api

0.0
No commit activity in last 3 years
No release in over 3 years
Extracts the name, uri, and events informaiton of an organization
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 2.8
~> 4.4
~> 5.9
~> 11.3
~> 0.42
~> 0.12
~> 3.0
~> 2.1

Runtime

~> 2.0
~> 1.7
 Project Readme

KKTIX API Gem

Gem Version Build Status

kktix_api is a gem that gets event information of an organization from KKTIX

Installation

If you are working on a project, add this to your Gemfile: gem 'kktix_api'

For ad hoc installation from command line:

$ gem install kktix_api

Usage

Execute kktix of an organization with specific organization_id; Otherwise, get latest published events.

$ kktix [org_id]

API

Require kktix_api gem in your code:

require 'kktix_api'

Get information using domain class Organization, you can get attributes like name, uri, and all the events held by the organization.

organization = KktixEvent::Organization.find('<organization_id>')

List events information from an Organization, including url, published, title,  summary, content, and author.

organization.events.each do |event|
  puts "#{event.title} (#{event.published})"
  puts event.url
  puts event.content
  puts
end

See the following example code for more usage details:

oid = 'nthuion'

acts = KktixEvent::KktixApi.events(oid)
puts acts

organization = KktixEvent::Organization.find(oid)
puts organization.name, organization.uri
organization.events.each do |event|
  puts event.title, event.published
end