kktix_api 0.1.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 14b3cd5a1e5bc69df6ab1e32de17b6b5e4b77af7
-  data.tar.gz: 6f15ff7424af4ca0751e7c6704a61d1a70a272ea
+  metadata.gz: 1d273e26139f81b11509b066a991ad7694254715
+  data.tar.gz: ee50aaf77c46d5ab5dbae817e31346039dc99b78
 SHA512:
-  metadata.gz: 824a0f62dfa70733042af073e431e7e75ea0c83ab8e935efeb7f5d919490c192b840d75b3f1ca201409b6ca50be0697a05cd35710ba3a1621ae1965b31eb9363
-  data.tar.gz: f5e0a4dd45c252f04933ca124bda5a0849919741248630393a6905f57544c42ffa782531c39bd81ac52ada888eb9707566a27e64689d7ba25bf2947257ed147f
+  metadata.gz: e3159983b678d9d7db54d28d580e1fcd812f7d96f89326d9c7490e90d057c897188f3a8c6eb48176bd66ab2c71a9a1b08b82e1e167b63be944068707bef81195
+  data.tar.gz: '0589951292caab3e76b66322b2357252dc6080b99e38d929bee7b7a64a4273d98932a95e0e02705d656def4bdb909d490cdd04b87623e7b598857015161f1a29'

data/.gitignore

@@ -1,8 +1,7 @@
 .DS_Store
 
-Gemfile.lock
 spec/fixtures/
 
 coverage/
 
-*.gem
+*.gem

data/Gemfile

@@ -2,6 +2,7 @@
 source 'https://rubygems.org'
 
 gem 'http'
+gem 'nokogiri'
 
 gem 'minitest'
 gem 'minitest-rg'

data/Gemfile.lock

@@ -0,0 +1,89 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.5.0)
+      public_suffix (~> 2.0, >= 2.0.2)
+    ast (2.3.0)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    docile (1.1.5)
+    domain_name (0.5.20161129)
+      unf (>= 0.0.5, < 1.0.0)
+    erubis (2.7.0)
+    flay (2.8.1)
+      erubis (~> 2.7.0)
+      path_expander (~> 1.0)
+      ruby_parser (~> 3.0)
+      sexp_processor (~> 4.0)
+    flog (4.4.0)
+      path_expander (~> 1.0)
+      ruby_parser (~> 3.1, > 3.1.0)
+      sexp_processor (~> 4.4)
+    hashdiff (0.3.2)
+    http (2.1.0)
+      addressable (~> 2.3)
+      http-cookie (~> 1.0)
+      http-form_data (~> 1.0.1)
+      http_parser.rb (~> 0.6.0)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    http-form_data (1.0.1)
+    http_parser.rb (0.6.0)
+    json (2.0.2)
+    mini_portile2 (2.1.0)
+    minitest (5.10.1)
+    minitest-rg (5.2.0)
+      minitest (~> 5.0)
+    nokogiri (1.7.0.1)
+      mini_portile2 (~> 2.1.0)
+    parser (2.3.3.1)
+      ast (~> 2.2)
+    path_expander (1.0.1)
+    powerpack (0.1.1)
+    public_suffix (2.0.5)
+    rainbow (2.2.1)
+    rake (12.0.0)
+    rubocop (0.46.0)
+      parser (>= 2.3.1.1, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.8.1)
+    ruby_parser (3.8.3)
+      sexp_processor (~> 4.1)
+    safe_yaml (1.0.4)
+    sexp_processor (4.7.0)
+    simplecov (0.12.0)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.2)
+    unicode-display_width (1.1.2)
+    vcr (3.0.3)
+    webmock (2.3.2)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  flay
+  flog
+  http
+  minitest
+  minitest-rg
+  nokogiri
+  rake
+  rubocop
+  simplecov
+  vcr
+  webmock
+
+BUNDLED WITH
+   1.13.6

data/README.md

@@ -1,8 +1,9 @@
-# kktix_api Gem
+# KKTIX API Gem
 
+[![Gem Version](https://badge.fury.io/rb/kktix_api.svg)](https://badge.fury.io/rb/kktix_api)
 [![Build Status](https://travis-ci.org/twentyfour7/kktix-api.svg?branch=master)](https://travis-ci.org/twentyfour7/kktix-api)
 
-kktix_api is a gem that gets event information of an organization from KKTIX
+kktix_api is a gem that gets event information of an organization from [KKTIX](https://kktix.com)
 
 ## Installation
 
@@ -10,18 +11,48 @@ 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```
+```console
+$ gem install kktix_api
+```
 
 
 ## Usage
 
-Require kktix_api gem in your code: `require 'kktix_api'`
+Execute `kktix` of an organization with specific `organization_id`; Otherwise, get latest published events.
+```console
+$ kktix [org_id]
+```
 
+### API
+
+Require kktix_api gem in your code:
+
+```ruby
+require 'kktix_api'
+```
+
+Get information using domain class `Organization`, you can get attributes like `name`, `uri`, and all the `events` held by the organization.
+
+```ruby
+organization = KktixEvent::Organization.find('<organization_id>')
+```
+
+
+List events information from an `Organization`, including `url`, `published`, `title`,  `summary`, `content`, and `author`.
+
+```ruby
+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:
 
 ```ruby
-oid = '<your organization id>'
+oid = 'nthuion'
 
 acts = KktixEvent::KktixApi.events(oid)
 puts acts
@@ -32,4 +63,4 @@ organization.events.each do |event|
   puts event.title, event.published
 end
 
-```
+```

data/Rakefile

@@ -1,16 +1,14 @@
 # frozen_string_literal: true
 require 'rake/testtask'
 
-task default: :spec
-
-# desc 'Run specs'
-# Rake::TestTask.new(name=:spec) do |t|
-#   t.pattern = 'spec/*_spec.rb'
-# end
+task :default do
+  puts `rake -T`
+end
 
-desc 'run tests'
-task :spec do
-  sh 'ruby spec/kktix_spec.rb'
+desc 'run specs'
+Rake::TestTask.new(:spec) do |t|
+  t.pattern = 'spec/*_spec.rb'
+  t.warning = false
 end
 
 desc 'delete cassette fixtures'

data/bin/kktix

@@ -3,22 +3,19 @@
 $LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
 require 'kktix_api'
 
-org_id = ARGV[0] || ENV['KKTIX_ORGANIZATION_ID']
-# unless org_id
-#   puts 'USAGE: kktix [org_id]'
-#   exit(1)
-# end
-
-organization = KktixEvent::Organization.find(org_id)
-
-unless organization.name.nil?
-  puts organization.name
-  puts '-' * organization.name.length
+keyword = ARGV[0]
+unless keyword
+  puts 'USAGE: kktix [keyword]'
+  exit(1)
 end
 
-organization.events.first(3).each.with_index(1) do |event, index|
+puts "Search for #{keyword}..."
+events = KktixEvent::Event.search(keyword)
+
+events.first(10).each.with_index(1) do |event, index|
   print "#{index}: "
-  puts "#{event.title} (#{event.published})"
-  puts event.summary ? event.summary : event.content
+  puts "#{event.title} (#{event.author[:name]})"
+  puts event.summary
+  puts event.content
   puts
 end

data/kktix_api.gemspec

@@ -16,6 +16,7 @@ Gem::Specification.new do |s|
   s.executables << 'kktix'
 
   s.add_runtime_dependency 'http', '~> 2.0'
+  s.add_runtime_dependency 'nokogiri', '~> 1.7'
 
   s.add_development_dependency 'minitest', '~> 5.9'
   s.add_development_dependency 'minitest-rg', '~> 5.2'

data/lib/kktix-api/event.rb

@@ -4,21 +4,28 @@ require_relative 'kktix_api'
 module KktixEvent
   # Single event on organiztion's feed
   class Event
-    attr_reader :url, :published, :title, :summary, :content, :author
+    attr_reader :url, :title, :summary, :content, :author
 
     def initialize(event_data)
       load_data(event_data)
     end
 
+    def self.search(query)
+      events_hash = KktixApi.search(query)
+      events = events_hash.map do |event_hash|
+        new(event_hash)
+      end
+      events
+    end
+
     private
 
     def load_data(event_data)
-      @url = event_data['url']
-      @published = event_data['published']
-      @title = event_data['title']
-      @summary = event_data['summary']
-      @content = event_data['content']
-      @author = event_data['author']
+      @url = event_data[:url]
+      @title = event_data[:title]
+      @summary = event_data[:summary]
+      @content = event_data[:content]
+      @author = event_data[:author]
     end
   end
 end

data/lib/kktix-api/kktix_api.rb

@@ -1,19 +1,68 @@
 # frozen_string_literal: true
 require 'yaml'
 require 'http'
+require 'open-uri'
+require 'nokogiri'
+require 'uri'
+require 'date'
 
 module KktixEvent
   # Service for retriving KKTIX events
   class KktixApi
-    def self.events(oid = nil)
-      response = HTTP.get(events_json_uri(oid: oid)).parse
-      return response['entry'] if response.key?('entry')
+    def self.events(slug: nil)
+      response = HTTP.get(events_json_uri(slug: slug)).parse
+      return hash_s_to_sym(response['entry']) if response.key?('entry')
       []
     end
 
-    def self.events_json_uri(oid: nil)
-      return 'https://kktix.com/events.json' if oid.nil?
-      "http://#{oid}.kktix.cc/events.json"
+    def self.search(query, start_at: Date.today)
+      start_at = start_at.to_s
+      uri = URI.escape("https://kktix.com/events?start_at=#{start_at}&search=#{query}")
+      doc = Nokogiri::HTML(open(uri))
+      parse_search_result(doc)
+    end
+
+    def self.events_json_uri(slug: nil)
+      return 'https://kktix.com/events.json' if slug.nil?
+      "http://#{slug}.kktix.cc/events.json"
+    end
+
+    private_class_method
+
+    def self.hash_s_to_sym(obj)
+      return obj.map { |hash| hash_s_to_sym(hash) } if obj.class == Array
+      obj.each_with_object({}) do |(k, v), memo|
+        # if v.class == Array
+        v = hash_s_to_sym(v) if v.class == Hash
+        memo[k.to_sym] = v
+        memo
+      end
+    end
+
+    def self.parse_search_result(doc)
+      events = doc.css('ul.event-list > li').map do |node|
+        title, url = parse_title node
+        date = node.css('.date').text
+        author = parse_author(node)
+        summary = node.css('> .description').text
+
+        { url: url, title: title, date: date, summary: summary, author: author }
+      end
+      events
+    end
+
+    def self.parse_title(node)
+      title_node = node.css('> h2 > a')
+      title = title_node.text.strip
+      url = title_node.attr('href').value
+      [title, url]
+    end
+
+    def self.parse_author(node)
+      author_node = node.css('.host')
+      name = author_node.text.strip
+      uri = author_node.css('> a').attr('href').value
+      { name: name, uri: uri }
     end
   end
 end

data/lib/kktix-api/organization.rb

@@ -5,28 +5,28 @@ require_relative 'event'
 module KktixEvent
   # Single organization on KKTIX
   class Organization
-    attr_reader :oid, :name, :uri, :events
+    attr_reader :slug, :name, :uri, :events
 
-    def initialize(organization_data, oid: nil)
-      update_info(organization_data, oid)
+    def initialize(organization_data, slug: nil)
+      update_info(organization_data, slug)
     end
 
-    def self.find(oid = nil)
-      organization_data = KktixEvent::KktixApi.events(oid)
-      new(organization_data, oid: oid)
+    def self.find(slug = nil)
+      events = KktixEvent::KktixApi.events(slug: slug)
+      new(events, slug: slug)
     end
 
     private
 
-    def update_info(entry, oid)
-      unless oid.nil?
-        author = entry.first['author']
-        @oid = oid
-        @name = author['name']
-        @uri = author['uri']
+    def update_info(events, slug)
+      unless slug.nil?
+        author = events.first[:author]
+        @slug = slug
+        @name = author[:name]
+        @uri = author[:uri]
       end
-      @events = entry.map do |event_data|
-        KktixEvent::Event.new(event_data)
+      @events = events.map do |event_data|
+        Event.new(event_data)
       end
     end
   end

data/lib/kktix-api/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module KktixEvent
+  VERSION = '1.0.0'
+end

data/spec/event_spec.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+require_relative 'spec_helper.rb'
+
+describe 'Event spec' do
+  VCR.configure do |c|
+    c.cassette_library_dir = CASSETTES_FOLDER
+    c.hook_into :webmock
+  end
+
+  before do
+    VCR.insert_cassette CASSETTE_FILE, record: :new_episodes
+    @organization = KktixEvent::Organization.find(TEST_ORG_SLUG)
+  end
+
+  after do
+    VCR.eject_cassette
+  end
+
+  it 'should be able to search events throuh api' do
+    KktixEvent::Event.search('go').wont_be_empty
+  end
+end

data/spec/kktix_spec.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 require_relative 'spec_helper.rb'
 
-describe 'KKTIX API spec' do
+describe 'KKTIX API get events spec' do
   VCR.configure do |c|
     c.cassette_library_dir = CASSETTES_FOLDER
     c.hook_into :webmock
@@ -20,38 +20,10 @@ describe 'KKTIX API spec' do
   end
 
   it 'should be able to return an empty array if the org does not exist' do
-    KktixEvent::KktixApi.events('notexist').empty?
-  end
-end
-
-describe 'KKTIX API spec' do
-  VCR.configure do |c|
-    c.cassette_library_dir = CASSETTES_FOLDER
-    c.hook_into :webmock
-  end
-
-  before do
-    VCR.insert_cassette CASSETTE_FILE, record: :new_episodes
-    @organization = KktixEvent::Organization.find(TEST_ORG_ID)
-  end
-
-  after do
-    VCR.eject_cassette
-  end
-
-  it 'should be the same oid of the organization' do
-    @organization.oid.must_equal TEST_ORG_ID
-  end
-
-  it 'should be able to get name of the organization' do
-    @organization.name.length.must_be :>, 0
-  end
-
-  it 'should be able to get uri of the organization' do
-    @organization.uri.length.must_be :>, 0
+    KktixEvent::KktixApi.events(slug: 'notexist').empty?
   end
 
-  it 'should be able to get events the organization' do
-    @organization.events.wont_be_empty
+  it 'should be able to search events throuh api' do
+    KktixEvent::KktixApi.search('go').wont_be_empty
   end
 end

data/spec/organization_spec.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+require_relative 'spec_helper.rb'
+
+describe 'Organization spec' do
+  VCR.configure do |c|
+    c.cassette_library_dir = CASSETTES_FOLDER
+    c.hook_into :webmock
+  end
+
+  before do
+    VCR.insert_cassette CASSETTE_FILE, record: :new_episodes
+    @organization = KktixEvent::Organization.find(TEST_ORG_SLUG)
+  end
+
+  after do
+    VCR.eject_cassette
+  end
+
+  it 'should be the same oid of the organization' do
+    @organization.slug.must_equal TEST_ORG_SLUG
+  end
+
+  it 'should be able to get name of the organization' do
+    @organization.name.length.must_be :>, 0
+  end
+
+  it 'should be able to get uri of the organization' do
+    @organization.uri.length.must_be :>, 0
+  end
+
+  it 'should be able to get events the organization' do
+    @organization.events.wont_be_empty
+  end
+end

data/spec/spec_helper.rb

@@ -14,6 +14,6 @@ FIXTURES_FOLDER = 'spec/fixtures'
 CASSETTES_FOLDER = "#{FIXTURES_FOLDER}/cassettes"
 CASSETTE_FILE = 'kktix_api'
 
-TEST_ORG_ID = 'nthuion'
+TEST_ORG_SLUG = 'nthuion'
 # KKTIX_RESPONSE = YAML.load(File.read('spec/fixtures/kktix_response.yml'))
 # TEST_ORG_INFO = YAML.load(File.read('spec/fixtures/nthuion_info.yml'))

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kktix_api
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 1.0.0
 platform: ruby
 authors:
 - JJC
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-30 00:00:00.000000000 Z
+date: 2017-01-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http
@@ -26,6 +26,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -164,6 +178,7 @@ files:
 - ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
+- Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
@@ -172,9 +187,12 @@ files:
 - lib/kktix-api/event.rb
 - lib/kktix-api/kktix_api.rb
 - lib/kktix-api/organization.rb
+- lib/kktix-api/version.rb
 - lib/kktix_api.rb
 - lib/test.rb
+- spec/event_spec.rb
 - spec/kktix_spec.rb
+- spec/organization_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/twentyfour7/kktix-api
 licenses:
@@ -196,10 +214,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Gets event content of an organization from KKTIX
 test_files:
+- spec/event_spec.rb
 - spec/kktix_spec.rb
+- spec/organization_spec.rb
 - spec/spec_helper.rb