wpcli 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1a849b2e8178a23a0e8cde15cc8c99594b40863f
+  data.tar.gz: 0fed61f994475d5dbb66678c9fca747371572c14
+SHA512:
+  metadata.gz: f89155c9d471e6cf8e08bba469ef9c01709b3b3e32079cd514ce4a024daaf27fefdcd42f251ca4d31164fd61e3bc2b83701367544714a64d8833721049e10fb9
+  data.tar.gz: 7c5f30f224c711781d71ebefbdd063e0a741cbab263a62fe9acf5cc2fc4b54ba96039eda9162618508db1ef7aec5d5cde35de16df8b5b31a5eb2944a8abe0a3c

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Joni Hasanen
+
+MIT License
+
+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

@@ -0,0 +1,56 @@
+# Wpcli
+
+Simple wrapper for wp-cli (http://wp-cli.org/).
+
+Just pass commands (http://wp-cli.org/commands/) to run method and use returned hash as you wish.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'wpcli'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install wpcli
+
+## Rails
+
+Simplest way to use in rails is to create config file and use methods from module.
+
+Generate example config
+
+    rails g wpcli:config
+
+Generated file (config/wpcli.yml)
+
+    apps:
+        key_for_installation: /absolute/path/for/my/wp-installation
+
+In controller include module
+
+    class MyController < ApplicationController
+      include Wpcli
+
+And then you can use client with key:
+
+     users = wpcli(:key_for_installation).run "user list"
+
+## Alternative way
+
+If you like to use client for example in command line, you can create instance with path of wordpress installation
+
+    @wpcli = Wpcli::Client.new "path/to/wp"
+    users = @wpcli.run "user list"
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/rails/generators/wpcli/config/config_generator.rb

@@ -0,0 +1,13 @@
+module Wpcli
+  class ConfigGenerator < Rails::Generators::Base
+    desc 'Generates example config for your rails app'
+
+    def self.source_root
+       @_wpcli_source_root ||= File.expand_path("../templates", __FILE__)
+     end
+
+     def create_config_file
+       template 'config_example.yml', File.join('config', 'wpcli.yml')
+     end
+    end
+end

data/lib/rails/generators/wpcli/config/templates/config_example.yml

@@ -0,0 +1,2 @@
+apps:
+    key_for_installation: /absolute/path/for/my/wp-installation

data/lib/wpcli/client.rb

@@ -0,0 +1,46 @@
+module Wpcli
+  class Client
+    def initialize path = ""
+      @path = path
+    end
+    def run command
+      output = `wp#{@path.empty? ? " " : " --path=" + @path + " "}#{command}`
+      parse output
+    end
+
+    private
+
+    def parse text
+      rows = []
+      text.split("\n").each_with_index do |line, index|
+        unless separator? line
+          if index < 3
+            @columns = parse_header line
+          else
+            rows << parse_line(line)
+          end
+        end
+      end
+      rows
+    end
+
+    def parse_header line
+      columns = []
+      line.split('|').each_with_index do |column, index|
+        columns[index] = column.strip.downcase unless column.strip.empty?
+      end
+      columns
+    end
+    def parse_line line
+      hash = {}
+      line.split('|').each_with_index do |column, index|
+        hash[@columns[index].to_sym] = column.strip unless @columns[index].nil?
+      end
+      hash
+    end
+
+    def separator? line
+      line.start_with? "+"
+    end
+  end
+end

data/lib/wpcli/rails.rb

@@ -0,0 +1,18 @@
+module Wpcli
+  def wpcli key
+    load_apps if @apps.nil?
+    @apps[key]
+  end
+
+  private
+
+  def load_apps
+    file = File.read("#{Rails.root}/config/wpcli.yml")
+    config = YAML.load(file)
+
+    @apps = {}
+    config["apps"].each do |key, path|
+      @apps[key] = Client.new path
+    end
+  end
+end

data/lib/wpcli/version.rb

@@ -0,0 +1,3 @@
+module Wpcli
+  VERSION = "0.1.0"
+end

data/lib/wpcli.rb

@@ -0,0 +1,3 @@
+require "wpcli/version"
+require "wpcli/client"
+require "wpcli/rails"

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+# 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
+
+require_relative "../lib/wpcli"
+
+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

data/spec/wpcli/client_spec.rb

@@ -0,0 +1,100 @@
+require 'spec_helper'
+
+describe Wpcli::Client do
+  let(:wp_user_list) do <<EOF
++----+--------------------------+----------------+------------------------------+---------------------+------------------------------------+
+| ID | user_login               | display_name   | user_email                   | user_registered     | roles                              |
++----+--------------------------+----------------+------------------------------+---------------------+------------------------------------+
+| 1  | test@domain.com          | Test 1         | test@domain.com              | 2013-11-24 19:26:45 | administrator                      |
+| 2  | test@domain.net          | Test 2         | test@domain.net              | 2013-11-25 12:41:38 | author                             |
++----+--------------------------+----------------+------------------------------+---------------------+------------------------------------+
+EOF
+    end
+
+  let(:wp_role_list) do <<EOF
++------------------+------------------------------------+
+| name             | role                               |
++------------------+------------------------------------+
+| Administrator    | administrator                      |
+| Editor           | editor                             |
+| Author           | author                             |
+| Contributor      | contributor                        |
+| Subscriber       | subscriber                         |
++------------------+------------------------------------+
+EOF
+    end
+  describe '.new' do
+    let(:path) { "path_to_wp" }
+    let(:command) { "user role" }
+
+    before :each do
+      @wpcli = Wpcli::Client.new path
+        @wpcli.stub(:`).with("wp --path=#{path} #{command}").and_return(wp_role_list)
+    end
+    context 'with path' do
+      it 'uses --path parameter' do
+        @array = @wpcli.run command
+        @array.kind_of?(Array).should be(true)
+      end
+    end
+  end
+  describe 'run' do
+    before :each do
+      @wpcli = Wpcli::Client.new
+    end
+
+    context 'role list' do
+      before :each do
+        @wpcli.stub(:`).with("wp role list").and_return(wp_role_list)
+        @array = @wpcli.run "role list"
+      end
+
+      describe 'returns array' do
+        it { @array.kind_of?(Array).should be(true)}
+
+        it 'which contains hashes' do
+          @array.first.kind_of?(Hash).should be(true)
+        end
+
+        it 'which has five hashes' do
+          @array.size.should eq(5)
+        end
+
+        it 'first hash has correct columns' do
+          @array.first.has_key?(:name).should be(true)
+          @array.first.has_key?(:role).should be(true)
+          @array.first.keys.size.should eq(2)
+        end
+      end
+    end
+
+    context 'user list' do
+      before :each do
+        @wpcli.stub(:`).with("wp user list").and_return(wp_user_list)
+        @array = @wpcli.run "user list"
+      end
+
+      describe 'returns array' do
+        it { @array.kind_of?(Array).should be(true) }
+
+        it 'which contains hashes' do
+          @array.first.kind_of?(Hash).should be(true)
+        end
+
+        it 'which has two hashes' do
+         @array.size.should eq(2)
+        end
+
+        it 'first hash has correct columns' do
+          @array.first.has_key?(:id).should be(true)
+          @array.first.has_key?(:display_name).should be(true)
+          @array.first.has_key?(:user_email).should be(true)
+          @array.first.has_key?(:user_registered).should be(true)
+          @array.first.has_key?(:user_login).should be(true)
+          @array.first.has_key?(:roles).should be(true)
+          @array.first.keys.size.should eq(6)
+        end
+      end
+    end
+  end
+end

data/wpcli.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'wpcli/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "wpcli"
+  spec.version       = Wpcli::VERSION
+  spec.authors       = ["Joni Hasanen"]
+  spec.email         = ["joni.hasanen@pieceofcode.net"]
+  spec.description   = %q{Simple wrapper for wp-cli}
+  spec.summary       = %q{Simple wrapper for wp-cli}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: wpcli
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Joni Hasanen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Simple wrapper for wp-cli
+email:
+- joni.hasanen@pieceofcode.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rails/generators/wpcli/config/config_generator.rb
+- lib/rails/generators/wpcli/config/templates/config_example.yml
+- lib/wpcli.rb
+- lib/wpcli/client.rb
+- lib/wpcli/rails.rb
+- lib/wpcli/version.rb
+- spec/spec_helper.rb
+- spec/wpcli/client_spec.rb
+- wpcli.gemspec
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.0
+signing_key: 
+specification_version: 4
+summary: Simple wrapper for wp-cli
+test_files:
+- spec/spec_helper.rb
+- spec/wpcli/client_spec.rb