wordpress_client 0.0.1

data/spec/paginated_collection_spec.rb

@@ -0,0 +1,64 @@
+require "spec_helper"
+
+module WordpressClient
+  describe PaginatedCollection do
+    it "wraps an array" do
+      list = ["one"]
+      pagination = PaginatedCollection.new(list, total: 1, per_page: 1, current_page: 1)
+
+      expect(pagination.each.to_a).to eq list
+      expect(pagination.to_a).to eq list
+      expect(pagination.size).to eq 1
+
+      expect(pagination.total).to eq 1
+      expect(pagination.per_page).to eq 1
+      expect(pagination.current_page).to eq 1
+    end
+
+    describe "pagination attributes" do
+      def collection(total: 1, per_page: 1, current_page: 1)
+        PaginatedCollection.new([], total: total, per_page: per_page, current_page: current_page)
+      end
+
+      it "includes total pages" do
+        expect(collection(total: 10, per_page: 5).total_pages).to eq 2
+        expect(collection(total: 11, per_page: 5).total_pages).to eq 3
+        expect(collection(total:  0, per_page: 5).total_pages).to eq 0
+        expect(collection(total: 10, per_page: 0).total_pages).to eq 0
+        expect(collection(total:  2, per_page: 9).total_pages).to eq 1
+      end
+
+      it "includes next page number" do
+        expect(collection(total: 10, per_page: 1, current_page:  1).next_page).to eq 2
+        expect(collection(total: 10, per_page: 1, current_page:  9).next_page).to eq 10
+        expect(collection(total: 10, per_page: 1, current_page: 10).next_page).to eq nil
+
+        expect(collection(total: 10, per_page: 0, current_page: 1).next_page).to eq nil
+      end
+
+      it "includes previous page number" do
+        expect(collection(total: 10, per_page: 1, current_page: 10).previous_page).to eq 9
+        expect(collection(total: 10, per_page: 1, current_page:  2).previous_page).to eq 1
+        expect(collection(total: 10, per_page: 1, current_page:  1).previous_page).to eq nil
+      end
+
+      it "is out of bounds if current page is after last page" do
+        expect(collection(total: 2, per_page: 1, current_page: 1)).to_not be_out_of_bounds
+        expect(collection(total: 2, per_page: 1, current_page: 2)).to_not be_out_of_bounds
+
+        expect(collection(total: 2, per_page: 1, current_page: 3)).to be_out_of_bounds
+        expect(collection(total: 2, per_page: 1, current_page: 0)).to be_out_of_bounds
+      end
+
+      # Only to be compatible with will_paginate < 3.0
+      it "has an offset" do
+        expect(collection(per_page:  5, current_page: 1).offset).to eq 0
+        expect(collection(per_page:  5, current_page: 2).offset).to eq 5
+        expect(collection(per_page: 50, current_page: 3).offset).to eq 100
+
+        expect(collection(per_page: 50, current_page: 0).offset).to eq 0
+        expect(collection(per_page:  0, current_page: 0).offset).to eq 0
+      end
+    end
+  end
+end

data/spec/post_spec.rb

@@ -0,0 +1,114 @@
+require "spec_helper"
+
+module WordpressClient
+  describe Post do
+    let(:fixture) { json_fixture("simple-post.json") }
+
+    it "can be parsed from JSON data" do
+      post = Post.parse(fixture)
+
+      expect(post.id).to eq 1
+      expect(post.title_html).to eq "Hello world!"
+      expect(post.slug).to eq "hello-world"
+
+      expect(post.url).to eq "http://example.com/2015/11/03/hello-world/"
+      expect(post.guid).to eq "http://example.com/?p=1"
+
+      expect(post.excerpt_html).to eq(
+        "<p>Welcome to WordPress. This is your first post. Edit or delete it, then start " \
+        "writing!</p>\n"
+      )
+
+      expect(post.content_html).to eq(
+        "<p>Welcome to WordPress. This is your first post. Edit or delete it, then start " \
+        "writing!</p>\n"
+      )
+
+      expect(post.date).to_not be nil
+      expect(post.updated_at).to_not be nil
+    end
+
+    it "parses categories" do
+      post = Post.parse(fixture)
+
+      expect(post.categories).to eq [
+        Category.new(
+          id: 1, name_html: "Uncategorized", slug: "uncategorized"
+        )
+      ]
+
+      expect(post.category_ids).to eq [1]
+    end
+
+    it "parses tags" do
+      post = Post.parse(fixture)
+
+      expect(post.tags).to eq [
+        Tag.new(
+          id: 2, name_html: "Foo", slug: "foo"
+        )
+      ]
+
+      expect(post.tag_ids).to eq [2]
+    end
+
+    it "can have a Media as featured image" do
+      media = instance_double(Media, id: 12)
+      post = Post.new(featured_image: media)
+
+      expect(post.featured_image).to eq media
+      expect(post.featured_image_id).to eq 12
+    end
+
+    describe "dates" do
+      it "uses GMT times if available" do
+        post = Post.parse(fixture.merge(
+          "date_gmt" => "2001-01-01T15:00:00",
+          "date" => "2001-01-01T12:00:00",
+          "modified_gmt" => "2001-01-01T15:00:00",
+          "modified" => "2001-01-01T12:00:00",
+        ))
+
+        expect(post.date).to eq Time.utc(2001, 1, 1, 15, 0, 0)
+        expect(post.updated_at).to eq Time.utc(2001, 1, 1, 15, 0, 0)
+      end
+
+      it "falls back to local time if no GMT date is provided" do
+        post = Post.parse(fixture.merge(
+          "date_gmt" => nil,
+          "date" => "2001-01-01T12:00:00",
+          "modified_gmt" => nil,
+          "modified" => "2001-01-01T12:00:00",
+        ))
+
+        expect(post.date).to eq Time.local(2001, 1, 1, 12, 0, 0)
+        expect(post.updated_at).to eq Time.local(2001, 1, 1, 12, 0, 0)
+      end
+    end
+
+    describe "metadata" do
+      it "is parsed into a hash" do
+        post = Post.parse(json_fixture("post-with-metadata.json"))
+        expect(post.meta).to eq "foo" => "bar"
+      end
+
+      it "raises UnauthorizedError when post it is forbidden" do
+        expect {
+          Post.parse(json_fixture("post-with-forbidden-metadata.json"))
+        }.to raise_error(UnauthorizedError)
+      end
+
+      it "keeps track of the ID of each metadata key" do
+        post = Post.parse(json_fixture("post-with-metadata.json"))
+        expect(post.meta_id_for("foo")).to eq 2
+      end
+
+      it "raises ArgumentError when asked for the meta ID of a meta key not present" do
+        post = Post.parse(json_fixture("post-with-metadata.json"))
+        expect {
+          post.meta_id_for("clearly unreal")
+        }.to raise_error(ArgumentError, /clearly unreal/)
+      end
+    end
+  end
+end

data/spec/replace_metadata_spec.rb

@@ -0,0 +1,56 @@
+require "spec_helper"
+
+module WordpressClient
+  describe ReplaceMetadata do
+    it "does nothing if the new metadata is equal to the existing one" do
+      post = instance_double(Post, id: 5, meta: {"existing" => "1"})
+
+      # Note: connection double does not accept any message.
+      connection = instance_double(Connection)
+
+      ReplaceMetadata.apply(connection, post, existing: "1")
+    end
+
+    it "adds missing metadata" do
+      connection = instance_double(Connection)
+      post = instance_double(Post, id: 5, meta: {"existing" => "1"})
+
+      expect(connection).to receive(:create_without_response).with(
+        "posts/5/meta", key: "new", value: "2"
+      )
+
+      ReplaceMetadata.apply(connection, post, existing: "1", new: "2")
+    end
+
+    it "replaces changed metadata" do
+      connection = instance_double(Connection)
+      post = instance_double(Post, id: 5, meta: {"change_me" => "1"})
+
+      expect(post).to receive(:meta_id_for).with("change_me").and_return(13)
+
+      expect(connection).to receive(:patch_without_response).with(
+        "posts/5/meta/13", key: "change_me", value: "2"
+      )
+
+      ReplaceMetadata.apply(connection, post, change_me: "2")
+    end
+
+    it "removes extra metadata" do
+      connection = instance_double(Connection)
+      post = instance_double(Post, id: 5, meta: {"old" => "1", "new" => "2"})
+
+      expect(post).to receive(:meta_id_for).with("old").and_return(45)
+      expect(connection).to receive(:delete).with("posts/5/meta/45", force: true)
+
+      ReplaceMetadata.apply(connection, post, new: "2")
+    end
+
+    it "returns the number of changes" do
+      connection = instance_double(Connection).as_null_object
+      post = instance_double(Post, id: 5, meta: {"old" => "1", "change" => "2"}).as_null_object
+
+      result = ReplaceMetadata.apply(connection, post, change: "3", extra: "4")
+      expect(result).to eq 3
+    end
+  end
+end

data/spec/replace_terms_spec.rb

@@ -0,0 +1,51 @@
+require "spec_helper"
+
+module WordpressClient
+  describe ReplaceTerms do
+    it "adds missing categories" do
+      connection = double(Connection)
+      post = double(Post, id: 40, category_ids: [1])
+
+      expect(connection).to receive(:create_without_response).with("posts/40/terms/category/5", {})
+
+      ReplaceTerms.apply_categories(connection, post, [1, 5])
+    end
+
+    it "removes extra categories" do
+      connection = double(Connection)
+      post = double(Post, id: 40, category_ids: [8, 9, 10])
+
+      expect(connection).to receive(:delete).with("posts/40/terms/category/8", force: true)
+      expect(connection).to receive(:delete).with("posts/40/terms/category/9", force: true)
+
+      ReplaceTerms.apply_categories(connection, post, [10])
+    end
+
+    it "adds missing tags" do
+      connection = double(Connection)
+      post = double(Post, id: 40, tag_ids: [1])
+
+      expect(connection).to receive(:create_without_response).with("posts/40/terms/tag/5", {})
+
+      ReplaceTerms.apply_tags(connection, post, [1, 5])
+    end
+
+    it "removes extra tags" do
+      connection = double(Connection)
+      post = double(Post, id: 40, tag_ids: [8, 9, 10])
+
+      expect(connection).to receive(:delete).with("posts/40/terms/tag/8", force: true)
+      expect(connection).to receive(:delete).with("posts/40/terms/tag/9", force: true)
+
+      ReplaceTerms.apply_tags(connection, post, [10])
+    end
+
+    it "returns the amount of changes made" do
+      connection = double(Connection).as_null_object
+      post = double(Post, id: 40, tag_ids: [8, 9, 10])
+
+      result = ReplaceTerms.apply_tags(connection, post, [10, 11])
+      expect(result).to eq 3
+    end
+  end
+end

data/spec/shared_examples/term_examples.rb

@@ -0,0 +1,37 @@
+shared_examples_for(WordpressClient::Term) do |fixture_name:|
+  it "has an id, name_html and slug" do
+    term = described_class.new(id: 5, name_html: "Heyho", slug: "heyho")
+    expect(term.id).to eq 5
+    expect(term.name_html).to eq "Heyho"
+    expect(term.slug).to eq "heyho"
+  end
+
+  it "can be parsed" do
+    term = described_class.parse(json_fixture(fixture_name))
+    expect(term.id).to be_kind_of Integer
+
+    expect(term.name_html).to be_kind_of String
+    expect(term.slug).to be_kind_of String
+    expect(term.name_html).to_not be_empty
+    expect(term.slug).to_not be_empty
+  end
+
+  it "is equal to other instances with the same id, name_html and slug" do
+    instance = described_class.new(id: 1, name_html: "One", slug: "one")
+    copy     = described_class.new(id: 1, name_html: "One", slug: "one")
+
+    expect(instance).to eq instance
+    expect(instance).to eq copy
+
+    expect(instance).to_not eq described_class.new(id: 2, name_html: "One", slug: "one")
+    expect(instance).to_not eq described_class.new(id: 1, name_html: "Two", slug: "one")
+    expect(instance).to_not eq described_class.new(id: 1, name_html: "One", slug: "two")
+  end
+
+  it "it not equal on other Term subclasses with the same id, name_html and slug" do
+    other_subclass = Class.new(WordpressClient::Tag)
+
+    term = described_class.new(id: 1, name_html: "One", slug: "one")
+    expect(term).to_not eq other_subclass.new(id: 1, name_html: "One", slug: "one")
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,28 @@
+if ENV['CODECLIMATE_REPO_TOKEN']
+  require "codeclimate-test-reporter"
+  CodeClimate::TestReporter.start
+end
+
+require "webmock/rspec"
+
+require_relative "support/wordpress_server"
+require_relative "support/fixtures"
+require_relative "support/integration_macros"
+
+$LOAD_PATH << File.expand_path("../../lib", __FILE__)
+require "wordpress_client"
+
+RSpec.configure do |config|
+  config.extend IntegrationMacros
+  config.include Fixtures
+
+  config.run_all_when_everything_filtered = true
+
+  config.before do
+    WebMock.disable_net_connect!(allow_localhost: false)
+  end
+
+  config.after do
+    WebMock.allow_net_connect!
+  end
+end

data/spec/support/docker_runner.rb

@@ -0,0 +1,49 @@
+require "shellwords"
+require "uri"
+
+module DockerRunner
+  extend self
+
+  def docker_installed?
+    system("hash docker > /dev/null 2> /dev/null")
+  end
+
+  def image_exists?(name)
+    system("docker images | grep -q '^#{name.shellescape} '")
+  end
+
+  def build_image(name, path: Dir.pwd)
+    system("cd #{path.shellescape} && docker build -t #{name.shellescape} .")
+  end
+
+  def run_container(name, port:, environment: {})
+    environment_flags = environment.map { |key, value|
+      "-e #{key.to_s.upcase.shellescape}=#{value.shellescape}"
+    }
+
+    output = `
+      docker run \
+        -dit -p #{port.to_i}:80 \
+        #{environment_flags.join(" ")} \
+        #{name.shellescape}
+    `
+    if $?.success?
+      output.chomp
+    else
+      fail "Failed to start container. Maybe it's already running? Output: #{output}"
+    end
+  end
+
+  def purge_container(id)
+    output = `docker kill #{id.shellescape}; docker rm #{id.shellescape} `
+
+    unless $?.success?
+      message = "Could not clean up docker image #{id}. Output was:\n#{output}.\n"
+      if ENV["CIRCLECI"]
+        puts message
+      else
+        raise message
+      end
+    end
+  end
+end

data/spec/support/fixtures.rb

@@ -0,0 +1,19 @@
+module Fixtures
+  FixtureRoot = Pathname.new(File.expand_path("../../fixtures", __FILE__))
+
+  def fixture_path(name)
+    FixtureRoot.join(name)
+  end
+
+  def fixture_contents(name)
+    fixture_path(name).read
+  end
+
+  def json_fixture(name)
+    JSON.parse(fixture_contents(name))
+  end
+
+  def open_fixture(name)
+    fixture_path(name).open('r') { |file| yield file }
+  end
+end

data/spec/support/integration_macros.rb

@@ -0,0 +1,10 @@
+module IntegrationMacros
+  def setup_integration_client
+    before { WebMock.allow_net_connect! }
+
+    let(:client) {
+      server = WordpressServer.instance
+      WordpressClient.new(url: server.url, username: server.username, password: server.password)
+    }
+  end
+end

data/spec/support/wordpress_server.rb

@@ -0,0 +1,103 @@
+require_relative "docker_runner"
+
+class WordpressServer
+  include Singleton
+
+  attr_reader :container_id, :port, :host
+
+  def initialize
+    @host = docker_host
+    @port = 8181
+
+    start_docker_container
+    at_exit { purge_container }
+  end
+
+  def url
+    "http://#{host_with_port}/wp-json"
+  end
+
+  # Defined in the dbdump in spec/docker/dbdump.sql.gz
+  def username() "test" end
+
+  # Defined in the dbdump in spec/docker/dbdump.sql.gz
+  def password() "test" end
+
+  private
+  def host_with_port
+    "#{host}:#{port}"
+  end
+
+  def docker_host
+    if ENV['DOCKER_HOST']
+      URI.parse(ENV['DOCKER_HOST']).host
+    else
+      "localhost"
+    end
+  end
+
+  def start_docker_container
+    fail_if_docker_missing
+    build_container_if_missing
+
+    @container_id = start_container
+    @running = true
+
+    begin
+      wait_for_container_to_start
+    rescue
+      purge_container
+      raise $!
+    end
+  end
+
+  def fail_if_docker_missing
+    unless DockerRunner.docker_installed?
+      STDERR.puts(
+        "It does not look like you have docker installed. " \
+        "Please install docker so you can run integration tests."
+      )
+      fail "No docker installed"
+    end
+  end
+
+  def build_container_if_missing
+    unless DockerRunner.image_exists?("wpclient-test")
+      DockerRunner.build_image("wpclient-test", path: "spec/docker")
+    end
+  end
+
+  def start_container
+    DockerRunner.run_container(
+      "wpclient-test",
+      port: port,
+      environment: {wordpress_host: host_with_port}
+    )
+  end
+
+  def purge_container
+    if @running
+      DockerRunner.purge_container(container_id)
+      @running = true
+    end
+  end
+
+  def wait_for_container_to_start
+    # Try to connect to the webserver in a loop until we successfully connect,
+    # the container process dies, or the timeout is reached.
+    timeout = 60
+    start = Time.now
+
+    loop do
+      fail "Timed out while waiting for the container to start" if Time.now - start > timeout
+
+      begin
+        response = Faraday.get(url)
+        return if response.status == 200
+      rescue Faraday::ConnectionFailed
+        # Server not yet started. Just wait it out...
+      end
+      sleep 0.5
+    end
+  end
+end