wikiwhat 0.0.2

data/spec/page_spec.rb

@@ -0,0 +1,177 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'rspec'
+require 'spec_helper'
+
+require_relative 'testfiles/api_call_contents'
+
+describe Wikiwhat::Page do
+  describe "#paragraphs" do
+    context "When #paragraphs is called on a Wikiwhat::Page object" do
+      let(:pigeon) { Wikiwhat::Page.new("Columba livia") }
+      it "calls Call.api" do
+        Wikiwhat::Call.stub(:call_api).and_return(wikiwhat_page_pigeon_extracts)
+        pigeon.paragraphs
+        expect(Wikiwhat::Call).to have_received(:call_api)
+      end
+      it "calls #paragraphs on a Wikiwhat::Text instance" do
+        Wikiwhat::Call.stub(:call_api).and_return(wikiwhat_page_pigeon_extracts)
+        expect_any_instance_of(Wikiwhat::Text).to receive(:paragraph).with(1)
+        pigeon.paragraphs
+      end
+    end
+    context 'When :num_paragraphs is set in the options hash' do
+      it "calls Call.api" do
+        Wikiwhat::Call.stub(:call_api).and_return(wikiwhat_page_pigeon_extracts)
+        pigeon = Wikiwhat::Page.new("Columba livia", :num_paragraphs => 2)
+        expect(Wikiwhat::Call).to have_received(:call_api)
+      end
+      it "calls #paragraphs on a Wikiwhat::Text instance" do
+        Wikiwhat::Call.stub(:call_api).and_return(wikiwhat_page_pigeon_extracts)
+        expect_any_instance_of(Wikiwhat::Text).to receive(:paragraph).with(2)
+        pigeon = Wikiwhat::Page.new("Columba livia", :num_paragraphs => 2)
+      end
+    end
+    context 'When :num_paragraphs is set in the options hash and is higher than
+            the number availble' do
+      it "calls #paragraphs on a Wikiwhat::Text instance" do
+        Wikiwhat::Call.stub(:call_api).and_return(wikiwhat_page_pigeon_extracts)
+        expect_any_instance_of(Wikiwhat::Text).to receive(:paragraph).with(999)
+        pigeon = Wikiwhat::Page.new("Columba livia", :num_paragraphs => 999)
+      end
+    end
+  end
+  describe "#image_list" do
+    context "When #image_list is called on a Wikiwhat::Page instance" do
+      let(:pigeon) { Wikiwhat::Page.new("Columba livia") }
+      it "calls Call.api" do
+        Wikiwhat::Call.stub(:call_api).and_return(wikiwhat_page_pigeon_image_list, wikiwhat_page_pigeon_img_url)
+        pigeon.image_list
+        expect(Wikiwhat::Call).to have_received(:call_api).at_least(1).times
+      end
+      it "calls #list_image on a Wikiwhat::Media instance" do
+        Wikiwhat::Call.stub(:call_api).and_return(wikiwhat_page_pigeon_image_list)
+        expect_any_instance_of(Wikiwhat::Media).to receive(:list_images)
+        pigeon.image_list
+      end
+    end
+    context "when img_list => true is specified in the options hash" do
+      it "calls Call.api" do
+        Wikiwhat::Call.stub(:call_api).and_return(wikiwhat_page_pigeon_image_list, wikiwhat_page_pigeon_img_url)
+        pigeon = Wikiwhat::Page.new("Columba livia", :img_list => true)
+        expect(Wikiwhat::Call).to have_received(:call_api).at_least(1).times
+      end
+      it "calls #paragraphs on a Wikiwhat::Media instance" do
+        Wikiwhat::Call.stub(:call_api).and_return(wikiwhat_page_pigeon_image_list)
+        expect_any_instance_of(Wikiwhat::Media).to receive(:list_images)
+        pigeon = Wikiwhat::Page.new("Columba livia", :img_list => true)
+      end
+    end
+  end
+  describe "#header" do
+    context "When a header present in the article is specified in the options hash," do
+      it "calls Call.api" do
+        Wikiwhat::Call.stub(:call_api).and_return(wikiwhat_page_pigeon_extracts)
+        pigeon = Wikiwhat::Page.new("Columba livia", :header => "Description")
+        expect(Wikiwhat::Call).to have_received(:call_api)
+      end
+      it "calls #header on a Wikiwhat::Text instance" do
+        Wikiwhat::Call.stub(:call_api).and_return(wikiwhat_page_pigeon_extracts)
+        expect_any_instance_of(Wikiwhat::Text).to receive(:find_header).with("Description")
+        pigeon = Wikiwhat::Page.new("Columba livia", :header => "Description")
+      end
+    end
+    context "When #header is called on a Wikiwhat::Page instance with an argument," do
+      let(:pigeon) { Wikiwhat::Page.new("Columba livia") }
+      it "calls Call.api" do
+        Wikiwhat::Call.stub(:call_api).and_return(wikiwhat_page_pigeon_extracts)
+        pigeon.header("Description")
+        expect(Wikiwhat::Call).to have_received(:call_api)
+      end
+      it "calls #header on a Wikiwhat::Text instance" do
+        Wikiwhat::Call.stub(:call_api).and_return(wikiwhat_page_pigeon_extracts)
+        expect_any_instance_of(Wikiwhat::Text).to receive(:find_header).with("Description")
+        pigeon = Wikiwhat::Page.new("Columba livia", :header => "Description")
+      end
+    end
+    context "When #header with no argument is called on a Wikiwhat::Page instance," do
+      let(:pigeon) { Wikiwhat::Page.new("Columba livia") }
+      it "Raises an exception" do
+        expect { pigeon.header }.to raise_error(ArgumentError)
+      end
+    end
+    context "When a header not present in the article is specified in the options hash" do
+      let(:pigeon) { Wikiwhat::Page.new("Columba livia", :header => "Biography") }
+      it "Raises an exception" do
+        Wikiwhat::Call.stub(:call_api).and_return(wikiwhat_page_pigeon_extracts)
+        expect { pigeon.header }.to raise_error(Wikiwhat::WikiwhatError)
+      end
+    end
+  end
+  describe "#ref_list" do
+    context "When refs => true is specified in the options hash" do
+      it "calls Call.api" do
+        Wikiwhat::Call.stub(:call_api).and_return(wikiwhat_page_pigeon_revisions)
+        pigeon = Wikiwhat::Page.new("Columba livia", :refs => true)
+        expect(Wikiwhat::Call).to have_received(:call_api)
+      end
+      it "calls #refs on a Wikiwhat::Text instance" do
+        Wikiwhat::Call.stub(:call_api).and_return(wikiwhat_page_pigeon_revisions)
+        expect_any_instance_of(Wikiwhat::Text).to receive(:refs)
+        pigeon = Wikiwhat::Page.new("Columba livia", :refs => true)
+      end
+    end
+    context "When #ref_list is called on a Wikiwhat::Page instance" do
+      let(:pigeon) { Wikiwhat::Page.new("Columba livia") }
+      it "calls Call.api" do
+        Wikiwhat::Call.stub(:call_api).and_return(wikiwhat_page_pigeon_revisions)
+        pigeon.ref_list
+        expect(Wikiwhat::Call).to have_received(:call_api)
+      end
+      it "calls #find_ref_list on a Wikiwhat::Text instance" do
+        Wikiwhat::Call.stub(:call_api).and_return(wikiwhat_page_pigeon_revisions)
+        expect_any_instance_of(Wikiwhat::Text).to receive(:refs)
+        pigeon.ref_list
+      end
+    end
+    context "When the page has no references" do
+      it "Does something about having no references" do
+        pending
+      end
+    end
+  end
+  describe "#sidebar_image" do
+    context "When sidebar_img => true is specified in the options hash" do
+      it "calls Call.api" do
+        Wikiwhat::Call.stub(:call_api).and_return(wikiwhat_page_pigeon_revisions, wikiwhat_page_pigeon_sidebar_image)
+        pigeon = Wikiwhat::Page.new("Columba livia", :sidebar_img => true)
+        expect(Wikiwhat::Call).to have_received(:call_api).at_least(1).times
+      end
+      it "calls #sidebar_image on a Wikiwhat::Text instance" do
+        Wikiwhat::Call.stub(:call_api).and_return(wikiwhat_page_pigeon_revisions, wikiwhat_page_pigeon_sidebar_image)
+        expect_any_instance_of(Wikiwhat::Text).to receive(:sidebar_image)
+        pigeon = Wikiwhat::Page.new("Columba livia", :sidebar_img => true)
+      end
+    end
+    context "When #sidebar_image is called on a Wikiwhat::Page instance" do
+      let(:pigeon) { Wikiwhat::Page.new("Columba livia") }
+      it "calls Call.api" do
+        Wikiwhat::Call.stub(:call_api).and_return(wikiwhat_page_pigeon_revisions, wikiwhat_page_pigeon_sidebar_image)
+        pigeon.sidebar_image
+        expect(Wikiwhat::Call).to have_received(:call_api).at_least(1).times
+      end
+      it "calls #sidebar_image on a Wikiwhat::Text instance" do
+        Wikiwhat::Call.stub(:call_api).and_return(wikiwhat_page_pigeon_revisions, wikiwhat_page_pigeon_sidebar_image)
+        expect_any_instance_of(Wikiwhat::Text).to receive(:sidebar_image)
+        pigeon.sidebar_image
+      end
+    end
+    context "When no sidebar image exists" do
+      let(:chad) { Wikiwhat::Page.new("Chad Muska") }
+      it "Raises an exception" do
+         Wikiwhat::Call.stub(:call_api).and_return(wikiwhat_page_chad_revisions)
+        expect { chad.sidebar_image }.to raise_error(Wikiwhat::WikiwhatError)
+      end
+    end
+  end
+end

data/spec/parse_spec.rb

@@ -0,0 +1,65 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'rspec'
+require 'spec_helper'
+
+require_relative 'testfiles/api_call_contents'
+
+describe Wikiwhat::Results do
+  let(:result){Wikiwhat::Results.new()}
+  describe "#pull_from_hash" do
+    it "looks for a key in a nested hash and returns the value" do
+
+      expect(result.pull_from_hash(ext_output, "extract")).to eq(ext_content)
+    end
+  end
+end
+
+describe Wikiwhat::Text do
+  let(:kel){Wikiwhat::Text.new(ext_output)}
+  let(:kel_rev){Wikiwhat::Text.new(rev_output, "revisions")}
+
+  describe "#paragraph" do
+    it"returns a number of paragraphs based on user input"do
+
+      expect(kel.paragraph(9999)).to eq(ext_all_paras)
+      expect(kel.paragraph(2)).to eq(ext_all_paras[0..1])
+    end
+  end
+
+  describe '#find header' do
+    it "returns paragraphs under a specific header" do
+
+      expect(kel.find_header("Personal")).to eq((ext_all_paras[5].split("</h2>")[1]+"\n"))
+    end
+  end
+
+  describe '#sidebar_image' do
+    it "returns the URL of the sidebar image, if any" do
+      Wikiwhat::Call.stub(:call_api).and_return(img_url_output)
+      expect(kel_rev.sidebar_image).to eq(img_url_content)
+    end
+  end
+
+  describe '#refs' do
+    it "returns an array of references in the wikipedia page" do
+
+      expect(kel_rev.refs).to eq(refs_content)
+    end
+  end
+end
+
+describe Wikiwhat::Media do
+  let(:albert){Wikiwhat::Media.new(img_output, "pages")}
+
+  describe '#list_images' do
+    it "pulls out file names and queries the api for their urls, returns an
+      array of urls" do
+      Wikiwhat::Call.stub(:call_api).and_return(media_list_1, media_list_2,
+        media_list_3, media_list_4, media_list_5, media_list_6, media_list_7,
+        media_list_8, media_list_9, media_list_10)
+
+      expect(albert.list_images).to eq(list_images_output)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,26 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'wikiwhat'
+# VCR for testing APIs
+require 'vcr'
+VCR.configure do |config|
+  config.cassette_library_dir = 'spec/fixtures/vcr_cassettes'
+  config.hook_into :webmock
+end
+# 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|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # 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