hyper_api 0.0.1 → 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 986c73fdfe7a49afe6537e0667029ce437b76f07
+  data.tar.gz: e4b30f076ef70dd52c935fb9ebeffcf9f6b6994b
+SHA512:
+  metadata.gz: c1c2781278743784fdb2205807048e5271b6e7bb0a9c68d3b1af03d9296e224f711e929db5da9bba2a52f239573a84c7af20897b5a2593ce10ececda0ddb6528
+  data.tar.gz: d6ab8dbe662c43eac9b79b609c3cb174f8494f44bbd486b4a2428b0e18c57ecede79464ed4e8d9c9af2438768c9c6c89bdfeaa30eda68c1e418093ae28841494

data/.gitignore

@@ -2,6 +2,8 @@
 *.rbc
 .bundle
 .config
+.rspec
+.ruby-version
 .yardoc
 Gemfile.lock
 InstalledFiles

data/Gemfile

@@ -1,4 +1,3 @@
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in hyper_api.gemspec
 gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2014 Javier Saldana
+
+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

@@ -16,7 +16,7 @@ The HyperAPI gem uses [Nokogiri](https://github.com/sparklemotion/nokogiri) to p
 Create objects on-the-go:
 
 ```ruby
-tpb_torrent = HyperAPI.new_class('TPB::Torrent') do
+Torrent = HyperAPI.new_class do
   string title: 'div#title'
   string description: 'div.info'
   string hash: '#details dd'
@@ -24,26 +24,47 @@ tpb_torrent = HyperAPI.new_class('TPB::Torrent') do
     attribute('href').value
   end
 end
-# => TPB::Torrent
+# => Torrent
+
+fringe = Torrent.new(html_string)
+# => #<TPB::Torrent title: 'Fringe Season 1', description: 'The complete season 1 of Fri...', imdb_id: 1119644>
+
+torrent = HyperAPI.new_class do
+  string title: 'div#title'
+  string description: 'div.info'
+  string hash: '#details dd'
+  integer imdb_id: '#details a[title=IMDB]' do
+    attribute('href').value
+  end
+end
+# => #<Class:0x007fda34829c48> // (anonymous class)
+
+fringe = torrent.new(html_string)
+# => #<Class:0x007fda34829c48 title: 'Fringe Season 1', description: 'The complete season 1 of Fri...', imdb_id: 1119644>
 
-fringe = tpb_torrent.new(html)
-# => #<TPB::Torrent title: 'Fringe Season 1', description: 'The complete season 1 of Fri...', imdb_id: '1119644'>
 ```
 
 Or create a new class:
 
 ```ruby
-class TPB::Torrent < HyperApi::Base
+class Torrent < HyperApi::Base
   string title: 'div#title'
   string description: 'div.info'
   string hash: '#details dd'
   integer imdb_id: '#details a[title=IMDB]' do
     attribute('href').value
   end
+
+  def some_calculated_method
+    "#{title}: #{hash}"
+  end
 end
 
-fringe = TPB::Torrent.new(html)
-# => #<TPB::Torrent title: 'Fringe Season 1', description: 'The complete season 1 of Fri...', imdb_id: '1119644'>
+fringe = Torrent.new(html_string)
+# => #<TPB::Torrent title: 'Fringe Season 1', description: 'The complete season 1 of Fri...', imdb_id: 1119644>
+
+fringe.some_calculated_method
+# => "Fringe Season 1: B4C04A34DD8824C28E9A8A528"
 ```
 
 ## Contributing
@@ -54,4 +75,4 @@ If you've found a bug or have a question, please open an issue on the [issue tra
 
 Copyright &copy; 2014 Javier Saldana
 
-Released under the MIT license. See [`LICENSE`]](LICENSE) for details.
+Released under the MIT license. See [`LICENSE`](LICENSE) for details.

data/hyper_api.gemspec

@@ -17,4 +17,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
+
+  spec.add_dependency 'nokogiri', '~> 1.6.0'
+  spec.add_development_dependency 'rspec', '~> 3.0.0.beta1'
 end

data/lib/hyper_api/version.rb

@@ -1,3 +1,3 @@
 module HyperAPI
-  VERSION = '0.0.1'
+  VERSION = '0.1.0'
 end

data/lib/hyper_api.rb

@@ -1,5 +1,59 @@
-require "hyper_api/version"
+require 'nokogiri'
+require 'hyper_api/version'
 
 module HyperAPI
-  # Code goes here...
+
+  def self.new_class(&block)
+    klass = Class.new(Base)
+    klass.class_eval(&block) if block_given?
+    klass
+  end
+
+  class Base
+    class << self
+      KNOWN_ATTRIBUTE_TYPES = %w(string integer float)
+
+      def known_attributes
+        @known_attributes ||= {}
+      end
+
+      KNOWN_ATTRIBUTE_TYPES.each do |attr_type|
+        # def string(name, path, &block)
+        #   known_attributes[name] = ['string', path, block]
+        # end
+        class_eval <<-EOV, __FILE__, __LINE__ + 1
+          def #{attr_type}(attribute, &block)
+            name, path = attribute.to_a.flatten
+            known_attributes[name] = ['#{attr_type}', path, block]
+          end
+        EOV
+      end
+    end
+
+    def initialize(html_string)
+      html = ::Nokogiri::HTML(html_string)
+      load_attributes(html)
+    end
+
+    def load_attributes(html)
+      known_attributes.each do |attr, options|
+        type, path, block = options
+
+        value = html.css(path)
+        value = block ? value.instance_eval(&block) : value.text
+        value = value.send("to_#{type[0]}")
+
+        instance_variable_set("@#{attr}", value)
+
+        self.class.send :define_method, attr do
+          instance_variable_get("@#{attr}")
+        end
+      end
+    end
+
+    def known_attributes
+      self.class.known_attributes
+    end
+
+  end
 end

data/spec/hyper_api_spec.rb

@@ -0,0 +1,58 @@
+require 'spec_helper'
+
+describe HyperAPI do
+
+  describe '.new_class' do
+    it 'inherits HyperAPI::Base' do
+      foo = HyperAPI.new_class
+      expect(foo.superclass).to eq(HyperAPI::Base)
+    end
+  end
+
+  it 'loads attributes from html string'do
+    person = HyperAPI.new_class do
+      string name: 'div#name'
+      integer imdb_id: 'div#imdb'
+    end
+
+    bob = person.new('<div id="name">Bob</div><div id="imdb">111999</div>')
+
+    expect(bob.name).to eq('Bob')
+    expect(bob.imdb_id).to eq(111999)
+  end
+
+  it 'takes a block to extract complex attributes' do
+    SomeLinkClass = HyperAPI.new_class do
+      string url: 'a' do
+        attribute('href').text
+      end
+    end
+
+    google = SomeLinkClass.new('<a href="http://google.com">Google</a>')
+
+    expect(google.url).to eq('http://google.com')
+  end
+
+  it 'supports custom classes' do
+    class Person < HyperAPI::Base
+      integer imdb_id: 'div#imdb'
+      string name: 'div#name'
+      string url: 'a' do
+        attribute('href').value
+      end
+
+      def some_method
+        "#{name}: #{url}"
+      end
+    end
+
+    b = '<div id="name">B</div><div id="imdb">1</div><a href="http://google.com">G</a>'
+    bob = Person.new(b)
+
+    expect(bob.name).to eq('B')
+    expect(bob.url).to eq('http://google.com')
+    expect(bob.imdb_id).to eq(1)
+    expect(bob.some_method).to eq('B: http://google.com')
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,25 @@
+require 'hyper_api'
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # Limit the spec run to only specs with the focus metadata. If no specs have
+  # the filtering metadata and `run_all_when_everything_filtered = true` then
+  # all specs will run.
+  config.filter_run :focus
+
+  # Run all specs when none match the provided filter. This works well in
+  # conjunction with `config.filter_run :focus`, as it will run the entire
+  # suite when no specs have `:filter` metadata.
+  config.run_all_when_everything_filtered = true
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -1,16 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: hyper_api
 version: !ruby/object:Gem::Version
-  version: 0.0.1
-  prerelease: 
+  version: 0.1.0
 platform: ruby
 authors:
 - Javier Saldana
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-15 00:00:00.000000000 Z
-dependencies: []
+date: 2014-02-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.0.beta1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.0.beta1
 description: 
 email:
 - javier@javiersaldana.com
@@ -20,35 +47,39 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - Gemfile
+- LICENSE
 - LICENSE.txt
 - README.md
 - Rakefile
 - hyper_api.gemspec
 - lib/hyper_api.rb
 - lib/hyper_api/version.rb
+- spec/hyper_api_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/jassa/hyper_api
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Hypertext API. A sweet DSL to create objects off HTML.
-test_files: []
+test_files:
+- spec/hyper_api_spec.rb
+- spec/spec_helper.rb