ex_ua 0.0.2 → 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5b80529d1a796a452c402596e0911c611cd09544
+  data.tar.gz: d576cc7c09db8586703340fce9e73bc9e2eca226
+SHA512:
+  metadata.gz: 75a02afae964de65c138426ec6d792e1c18d8234353d796c8153d3d66c5d802eda8870c8ee0bb15126a07059b07d8462e6f06ad44a44a8cca9dc8b26a794fe1c
+  data.tar.gz: b276646a9b6d09b7505bc7f5f268cb4bfa82a73efe4ad8fa469e2e2c765abc0aa79614c893a6cfd7e81edd6110467b36e240c8b94bb92bc06ed568f00148d169

data/README.md

@@ -3,6 +3,8 @@ Description
 
 ex_ua library gives you some API to access http://ex.ua/
 
+Docs: http://rubydoc.info/github/Antti/ex_ua/master/frames
+
 Install
 =======
 
@@ -16,5 +18,6 @@ Example usage
     client = ExUA::Client.new
     base_categories = client.base_categories('ru') # Gives you array of all base categories for a given language
     category = base_categories.first # Select first category (usually video)
-    sub_categories = category.categories
-
+    sub_categories = category.categories # Select sub-categories of a category
+    example_video_category = sub_categories.first.categories.first
+    download_items = example_video_category.items # Here you'll have an array of download items in a given category with #download_url

data/ex_ua.gemspec

@@ -19,6 +19,8 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   # specify any dependencies here; for example:
-  s.add_development_dependency "rspec"
-  s.add_runtime_dependency "mechanize"
+  s.add_development_dependency "rspec", '>= 2.10.0'
+  s.add_development_dependency "rake", '>= 0.9.0'
+  s.add_runtime_dependency "httparty", '>= 0.10.0'
+  s.add_runtime_dependency "nokogiri", '>= 1.5.0'
 end

data/lib/ex_ua/category.rb

@@ -1,14 +1,24 @@
+# @author Andrii Dmytrenko
+require 'cgi'
 module ExUA
   # Represents a category
+  # @example Usage
+  #   #You usually get categories thru ExUA::Client object
+  #   client = ExUA::Client.new
+  #   categories = client.base_categories('ru')
+  #   sub_categories = categories.first.categories
+  #   items = sub_categories.first.categories.first.items
   class Category
+    class NotFound < StandardError; end
     attr_reader :id,:parent, :url
 
-    # @params[ExUA::Client] ex_ua client
-    # @params[Fixnum] id Category id
-    # @params[Hash] options
-    def initialize(ex_ua, id, options={})
-      @ex_ua,@id = ex_ua, id
-      @url = options[:url] || url_from_id(id)
+    # @param[ExUA::Client] ex_ua client
+    # @param[Fixnum] id Category id
+    # @param[Hash] options
+    def initialize(ex_ua, options={})
+      @ex_ua = ex_ua
+      @id = options[:id]
+      @url = strip_url(options[:url]) || url_from_id(id)
       @name = options.delete(:name)
       @parent = options.delete(:parent)
     end
@@ -22,30 +32,38 @@ module ExUA
     end
 
     # Canonical url
+    # @return [String]
     def canonical_url
       @canonical_url ||= page_content.root.xpath("//link[@rel='canonical']/@href").first.value
     end
 
     # Category name
+    # @return [String]
     def name
       @name ||= page_content.root.xpath("//meta[@name='title']/@content").first.value
     end
 
     # Category description
+    # @return [String]
     def description
       @description ||= page_content.root.xpath("//meta[@name='description']/@content").first.value
     end
 
     # Category picture
+    # @return [String] url for a picture
     def picture
-      @picture ||= page_content.root.xpath("//link[@rel='image_src']/@href").first.value.split("?").first
+      @picture ||= (
+        pic = page_content.root.xpath("//link[@rel='image_src']/@href").first
+        pic && pic.value.split("?").first
+      )
     end
 
     # List of subcategories
+    # @return [Array<ExUA::Category>]
     def categories
       page_content.search('table.include_0 a b').map do |link|
-        if match = link.parent.attributes["href"].value.match(%r{/view/(?<id>\d+)\?r=(?<r>\d+)})
-          Category.new(@ex_ua,match[:id], parent: self, name: link.text)
+        if match = link.parent.attributes["href"].value.match(%r{/(?<url>\d+)\?r=(?<r>\d+)})
+          Category.new(@ex_ua, parent: self, url: match['url'], name: link.text)
         end
       end.compact
     end
@@ -61,45 +79,45 @@ module ExUA
     end
 
     # Next category
+    # @return [ExUA::Category]
     def next
-      Category.new(@ex_ua, self.id, url: next_url)
+      raise NotFound, "No link to a next category found" unless next?
+      Category.new(@ex_ua, id: self.id, url: next_url)
     end
 
     # Previous category
+    # @return [ExUA::Category]
     def prev
-      Category.new(@ex_ua, self.id, url: prev_url)
+      raise NotFound, "No link to a previous category found" unless prev?
+      Category.new(@ex_ua, id: self.id, url: prev_url)
     end
 
     # Current page number
+    # @return [Fixnum]
     def page
-      CGI.parse(URI.parse(@url).query||"")["p"].first || 0
+      CGI.parse(URI.parse(@url).query||"")["p"].first.to_i || 0
     end
 
     # Download items
+    # @return [Array<ExUA::Item>]
     def items
       table_rows = page_content.search('table.list tr')
       table_rows.map do |tr|
         tr.search("a[title!='']")
       end.reject(&:empty?).map do |links|
-        Item.new.tap do |item|
-          links.each { |link|
-            case link.attributes["href"].value
-            when %r{^/get/}
-              item.title = link.attributes["title"].value
-              item.id = link.attributes["href"].value.match(%r{^/get/(\d+)})[1].to_i
-            when %r{^/load}
-              item.additional_servers||=[]
-              item.additional_servers << link.attributes["title"].value.match(%r{fs(\d+)})[1].to_i
-            end
-          }
-        end
+        Item.parse_links(links)
       end
     end
 
     protected
 
+    def strip_url(url)
+      return unless url
+      url.sub(ExUA::BASE_URL, '')
+    end
+
     def page_content
-      @page_content||=@ex_ua.agent.get("#{ExUA::BASE_URL}#{@url}")
+      @page_content||=@ex_ua.get(url)
     end
 
     def url_from_id(id)
@@ -107,11 +125,17 @@ module ExUA
     end
 
     def next_url
-      @next_url||=page_content.root.xpath("//link[@rel='next']/@href").first.tap{|a| a.value if a}
+      @next_url||=(
+        e = page_content.root.xpath("//link[@rel='next']/@href").first
+        e && e.value
+      )
     end
 
     def prev_url
-      @prev_url||=page_content.root.xpath("//link[@rel='prev']/@href").first.tap{|a| a.value if a}
+      @prev_url||=(
+        e = page_content.root.xpath("//link[@rel='prev']/@href").first
+        e && e.value
+      )
     end
   end
 end

data/lib/ex_ua/client.rb

@@ -0,0 +1,30 @@
+require 'httparty'
+require 'nokogiri'
+
+module ExUA
+  # Client for ExUA
+  # @example Usage
+  #   client = ExUA::Client.new
+  #   categories = client.base_categories('ru')
+  #
+  class Client
+    # List of available languages
+    # @return [Array<String>]
+    def available_languages
+      @available_langauges||=get('/').search('select[name=lang] option').inject({}){|acc,el| acc[el.attributes["value"].value]=el.text;acc}
+    end
+
+    # List of base categories for a given language
+    # @param[String] lang Language
+    # @example Usage
+    #   client.base_categories('ru')
+    # @return [Array<ExUA::Category>]
+    def base_categories(lang)
+      ExUA::KNOWN_BASE_CATEGORIES.map{|cat| Category.new(self, url: "/#{lang}/#{cat}")}
+    end
+
+    def get(url)
+      Nokogiri.parse(HTTParty.get("#{ExUA::BASE_URL}#{url}").body)
+    end
+  end
+end

data/lib/ex_ua/item.rb

@@ -1,8 +1,24 @@
+# @author Andrii Dmytrenko
 module ExUA
   # Download item
   class Item < Struct.new(:id, :title, :additional_servers)
+    def self.parse_links(links)
+      self.new.tap do |item|
+        links.each { |link|
+          case link.attributes["href"].value
+          when %r{^/get/}
+            item.title = link.attributes["title"].value
+            item.id = link.attributes["href"].value.match(%r{^/get/(\d+)})[1].to_i
+          when %r{^/load}
+            item.additional_servers||=[]
+            item.additional_servers << link.attributes["title"].value.match(%r{fs(\d+)})[1].to_i
+          end
+        }
+      end
+    end
     # Actual download url.
     # You can add ?fs_id=server_id  param to download form #additional_servers
+    # @return[String] download_url
     def download_url
       "#{ExUA::BASE_URL}#{url}"
     end

data/lib/ex_ua/version.rb

@@ -1,3 +1,3 @@
 module ExUa
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/lib/ex_ua.rb

@@ -1,39 +1,10 @@
-module ExUA
-  BASE_URL='http://ex.ua'
-end
+# @author Andrii Dmytrenko
 require "ex_ua/version"
+require 'ex_ua/client'
 require "ex_ua/item"
 require "ex_ua/category"
-require 'mechanize'
 
 module ExUA
-  # Client for ExUA
-  # @example Usage
-  #   client = ExUA::Client.new
-  #   categories = client.base_categories('ru')
-  #
-  class Client
-    attr_reader :agent
-
-    def initialize
-      @agent = Mechanize.new
-    end
-
-    def inspect
-      "#<#{self.class}>"
-    end
-
-    # List of available languages
-    def available_languages
-      @available_langauges||=@agent.get(BASE_URL).search('select[name=lang] option').inject({}){|acc,el| acc[el.attributes["value"].value]=el.text;acc}
-    end
-
-    # List of base categories for a given language
-    # @param[String] lang Language
-    # @example
-    #   client.base_categories('ru')
-    def base_categories(lang)
-      %w[video audio images texts games software].map{|cat| Category.new(self, nil, url: "/#{lang}/#{cat}")}
-    end
-  end
+  BASE_URL='http://www.ex.ua'
+  KNOWN_BASE_CATEGORIES = %w[video audio images texts games software]
 end

data/spec/category_spec.rb

@@ -1,4 +1,41 @@
 require 'spec_helper'
 describe ExUA::Category do
-  pending
-end
+  context "general 1 page category" do
+    subject{ExUA::Category.new(client, url: 'ru_video.html')}
+    describe '#categories' do
+      it 'returns list of child categories' do
+        subject.categories.should be_kind_of(Array)
+      end
+      it 'has current category as a parent category for all childs' do
+        subject.categories.all?{|c| c.parent == subject}.should be_true
+      end
+    end
+    its(:items){should_not be_nil}
+    its(:name){should eq("\u0412\u0438\u0434\u0435\u043E [RU - \u0440\u0443\u0441\u0441\u043A\u0438\u0439]")}
+    its(:description){should_not be_nil}
+    its(:canonical_url){should_not be_nil}
+    its(:next?){should be_false}
+    its(:prev?){should be_false}
+  end
+  context "general few pages category" do
+    subject{ExUA::Category.new(client, url: 'foreign_video_russia.html')}
+    describe '#next' do
+      it 'returns a category with same url, but different page number' do
+        subject.next.url.should eq('/ru/video/foreign?r=23775&p=1')
+      end
+    end
+    describe '#prev' do
+      it 'returns a category with same url, but different page number' do
+        pending 'find a page with prev'
+        expect(subject.prev.url).to eq('')
+      end
+      it 'raises error when no prev url found' do
+        expect{subject.prev}.to raise_error(ExUA::Category::NotFound)
+      end
+    end
+  end
+  context "item category" do
+    subject{ExUA::Category.new(client, url: 'video_test.html')}
+    its(:picture){should_not be_nil}
+  end
+end

data/spec/client_spec.rb

@@ -1,4 +1,17 @@
 require 'spec_helper'
 describe ExUA::Client do
-  pending
-end
+  describe '#available_languages' do
+    it 'returns list of available languages' do
+      client.available_languages.should be_kind_of(Hash)
+    end
+    it 'includes known languages' do
+      known_languages = ["en", "ru", "uk"]
+      (client.available_languages.keys & known_languages).sort.should eq(known_languages)
+    end
+  end
+  describe '#base_categories' do
+    it 'lists base categories for a language' do
+      client.base_categories("uk").should be_kind_of(Array)
+    end
+  end
+end