Merge pull request #24 from itskingori/docs

Centralise docs, update documentation and other updates

.gitignore

@@ -1,19 +1,8 @@
-# Bundler #
-/.bundle
-/vendor/bundle
-
-# Coveralls #
+/.bundle/
+/.yardoc/
 /coverage/
-
-# Jekyll #
-_site
-
-# Yard #
-.yardoc/*
-
-# Gem #
-/log/*
-/tmp/*
+/docs/_site/
 Gemfile.lock
 *.gem
 .ruby-version
+!docs/.ruby-version

.travis.yml

@@ -3,8 +3,10 @@ before_install:
   - gem update --system
   - gem install bundler
 rvm:
-  - 2.3
-  - 2.2
-  - 2.1
-  - 2.0
+  - '2.4.0'
+  - '2.3.3'
+  - '2.2.6'
+  - '2.1.9'
+  - '2.0.0-p648'
 script: bundle exec rspec spec
+sudo: false

CHANGELOG.md

@@ -10,6 +10,8 @@ v2.0.0
 * Remove all Rails specific stuff.
 * Add `bin/` folder and some executables.
 * Improve gemspec.
+* Move docs from `gh-pages` branch to `docs/`.
+* Update documentation (tutorial and API reference).
 
 v1.8.0
 ------

LICENSE.md

@@ -1,7 +1,7 @@
 License
 =======
 
-Copyright (c) 2013-2016 King'ori Maina
+Copyright (c) 2013-2017 King'ori Maina
 
 MIT License
 

README.md

@@ -2,10 +2,10 @@
 ===============
 
 [![Gem Version](https://badge.fury.io/rb/pesapal.svg)](https://badge.fury.io/rb/pesapal)
-[![Build Status](https://travis-ci.org/itsmrwave/pesapal-gem.svg?branch=master)](https://travis-ci.org/itsmrwave/pesapal-gem)
-[![Code Climate](https://codeclimate.com/github/itsmrwave/pesapal-gem/badges/gpa.svg)](https://codeclimate.com/github/itsmrwave/pesapal-gem)
-[![Coverage Status](https://coveralls.io/repos/github/itsmrwave/pesapal-gem/badge.svg?branch=master)](https://coveralls.io/github/itsmrwave/pesapal-gem?branch=master)
-[![Dependency Status](https://gemnasium.com/badges/github.com/itsmrwave/pesapal-gem.svg)](https://gemnasium.com/github.com/itsmrwave/pesapal-gem)
+[![Build Status](https://travis-ci.org/itskingori/pesapal-gem.svg?branch=master)](https://travis-ci.org/itskingori/pesapal-gem)
+[![Code Climate](https://codeclimate.com/github/itskingori/pesapal-gem/badges/gpa.svg)](https://codeclimate.com/github/itskingori/pesapal-gem)
+[![Coverage Status](https://coveralls.io/repos/github/itskingori/pesapal-gem/badge.svg?branch=master)](https://coveralls.io/github/itskingori/pesapal-gem?branch=master)
+[![Dependency Status](https://gemnasium.com/badges/github.com/itskingori/pesapal-gem.svg)](https://gemnasium.com/github.com/itskingori/pesapal-gem)
 
 
 Basically it's a gem that makes it easy to integrate your app with
@@ -32,32 +32,28 @@ Add this line to your application's Gemfile:
 
 And then execute:
 
-    $ bundle
+    $ bundle install
 
 Or install it yourself as:
 
     $ gem install pesapal
 
-For Rails, you need to run the generator to create sample pesapal.yml file:
-
-    rails generate pesapal:install
-
 
 License
 -------
 
-[King'ori J. Maina][7] © 2013-2016. The [MIT License bundled therein][8] is a
+[King'ori J. Maina][7] © 2013-2017. The [MIT License bundled therein][8] is a
 permissive license that is short and to the point. It lets people do anything
 they want as long as they provide attribution and waive liability.
 
 [1]: https://www.pesapal.com/
-[2]: http://itsmrwave.github.io/pesapal-gem
+[2]: http://itskingori.github.io/pesapal-gem
 [3]: http://oauth.net/core/1.0/
 [4]: http://rubygems.org/gems/pesapal
-[5]: https://raw.githubusercontent.com/itsmrwave/pesapal-gem/master/CHANGELOG.md
-[6]: https://github.com/itsmrwave/pesapal-gem/releases/
+[5]: https://raw.githubusercontent.com/itskingori/pesapal-gem/master/CHANGELOG.md
+[6]: https://github.com/itskingori/pesapal-gem/releases/
 [7]: http://kingori.co/
-[8]: https://raw.githubusercontent.com/itsmrwave/pesapal-gem/master/LICENSE.md
+[8]: https://raw.githubusercontent.com/itskingori/pesapal-gem/master/LICENSE.md
 [9]: http://rubydoc.info/gems/pesapal/frames/file/README.md
 [10]: http://mogetutu.com/
 [11]: https://github.com/mogetutu

docs/.ruby-version

@@ -0,0 +1 @@
+2.3.3

docs/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Bootstrap the GitHub Pages Jekyll environment locally.
+gem 'github-pages'

docs/README.md

@@ -0,0 +1,10 @@
+Homepage built on [Jekyll][1].
+
+Run locally in a way that matches the GitHub Pages build server:
+
+```
+$ cd docs/
+$ bundle exec jekyll serve --watch --safe --trace --baseurl=''
+```
+
+[1]: http://jekyllrb.com/

docs/_config.yml

@@ -0,0 +1,27 @@
+name: Pesapal Ruby Gem
+highlighter: rouge
+baseurl: /pesapal-gem
+relative_permalinks: false
+
+sass:
+  sass_dir: _sass
+  style: :compressed
+
+exclude: [
+  'Gemfile',
+  'Gemfile.lock',
+  'README.md'
+]
+
+markdown: kramdown
+kramdown:
+  input: GFM
+  auto_id_prefix: ''
+  auto_id_stripping: true
+  auto_ids: true
+  entity_output: as_char
+  footnote_backlink: '&8617;'
+  footnote_nr: 1
+  hard_wrap: false
+  smart_quotes: lsquo,rsquo,ldquo,rdquo
+  toc_levels: 1..6

docs/_includes/google-analytics.html

@@ -0,0 +1,8 @@
+<script>
+  (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
+  (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
+  m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
+  })(window,document,'script','//www.google-analytics.com/analytics.js','ga');
+  ga('create', 'UA-39877044-1', 'kingori.co');
+  ga('send', 'pageview');
+</script>

docs/_layouts/default.html

@@ -0,0 +1,53 @@
+<!DOCTYPE html>
+<!--[if IE 9]><html class="lt-ie10" lang="en" > <![endif]-->
+<html class="no-js" lang="en" >
+
+  <head>
+
+    <!-- +++ META +++ -->
+    <meta charset="utf-8">
+    <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
+    <meta name="viewport" content="width=device-width, initial-scale=1, user-scalable=no">
+
+    <!-- +++ PAGE INFO +++ -->
+    <title>{{ page.title }} • {{ site.name }}</title>
+
+    <!-- +++ FAVICON & ICONS: combined 16, 32 & 48 +++ -->
+    <link rel="shortcut icon" type="image/x-icon" href="{{ site.baseurl }}/favicon.ico">
+
+    <!-- +++ STYLESHEETS +++ -->
+    <link rel="stylesheet" href="{{ site.baseurl }}/assets/stylesheets/styles.css">
+    <link rel="stylesheet" href="{{ site.baseurl }}/assets/stylesheets/pygment_trac.css">
+
+    <!-- +++ JAVASCRIPTS +++ -->
+    <script type="text/javascript" src="{{ site.baseurl }}/assets/javascripts/scale.fix.js"></script>
+  </head>
+
+  <body>
+    <div class="wrapper">
+      <header>
+        <h1>Pesapal Gem</h1>
+        <a href="https://rubygems.org/gems/pesapal"><img src="https://badge.fury.io/rb/pesapal@2x.png" alt="Gem Version" height="18"></a><br/><br/>
+        <p>Make authenticated Pesapal API calls without the fuss! Easily post an order, query payment status and fetch payment details.</p>
+        <p class="view"><a href="https://github.com/itskingori/pesapal-gem">View the Project on GitHub <small>itskingori/pesapal-gem</small></a></p>
+        <ul>
+          <li><a href="https://github.com/itskingori/pesapal-gem/zipball/master">Download <strong>ZIP File</strong></a></li>
+          <li><a href="https://github.com/itskingori/pesapal-gem/tarball/master">Download <strong>TAR Ball</strong></a></li>
+          <li><a href="https://github.com/itskingori/pesapal-gem/fork">Fork On <strong>GitHub</strong></a></li>
+        </ul>
+      </header>
+      <section>
+        {{ content }}
+      </section>
+      <footer>
+        <p>
+          This project is maintained by <a target="_blank" href="http://kingori.co/">King</a>.<br/>
+          Special thanks to <a target="_blank" href="https://twitter.com/mogetutu">@Mogetutu</a>.
+        </p>
+        <p>
+        <small>Hosted on GitHub Pages</small></p>
+      </footer>
+    </div>
+    {% include google-analytics.html %}
+  </body>
+</html>

docs/assets/javascripts/scale.fix.js

@@ -0,0 +1,17 @@
+var metas = document.getElementsByTagName('meta');
+var i;
+if (navigator.userAgent.match(/iPhone/i)) {
+  for (i=0; i<metas.length; i++) {
+    if (metas[i].name == "viewport") {
+      metas[i].content = "width=device-width, minimum-scale=1.0, maximum-scale=1.0";
+    }
+  }
+  document.addEventListener("gesturestart", gestureStart, false);
+}
+function gestureStart() {
+  for (i=0; i<metas.length; i++) {
+    if (metas[i].name == "viewport") {
+      metas[i].content = "width=device-width, minimum-scale=0.25, maximum-scale=1.6";
+    }
+  }
+}

docs/assets/stylesheets/pygment_trac.css

@@ -0,0 +1,69 @@
+.highlight  { background: #ffffff; }
+.highlight .c { color: #999988; font-style: italic } /* Comment */
+.highlight .err { color: #a61717; background-color: #e3d2d2 } /* Error */
+.highlight .k { font-weight: bold } /* Keyword */
+.highlight .o { font-weight: bold } /* Operator */
+.highlight .cm { color: #999988; font-style: italic } /* Comment.Multiline */
+.highlight .cp { color: #999999; font-weight: bold } /* Comment.Preproc */
+.highlight .c1 { color: #999988; font-style: italic } /* Comment.Single */
+.highlight .cs { color: #999999; font-weight: bold; font-style: italic } /* Comment.Special */
+.highlight .gd { color: #000000; background-color: #ffdddd } /* Generic.Deleted */
+.highlight .gd .x { color: #000000; background-color: #ffaaaa } /* Generic.Deleted.Specific */
+.highlight .ge { font-style: italic } /* Generic.Emph */
+.highlight .gr { color: #aa0000 } /* Generic.Error */
+.highlight .gh { color: #999999 } /* Generic.Heading */
+.highlight .gi { color: #000000; background-color: #ddffdd } /* Generic.Inserted */
+.highlight .gi .x { color: #000000; background-color: #aaffaa } /* Generic.Inserted.Specific */
+.highlight .go { color: #888888 } /* Generic.Output */
+.highlight .gp { color: #555555 } /* Generic.Prompt */
+.highlight .gs { font-weight: bold } /* Generic.Strong */
+.highlight .gu { color: #800080; font-weight: bold; } /* Generic.Subheading */
+.highlight .gt { color: #aa0000 } /* Generic.Traceback */
+.highlight .kc { font-weight: bold } /* Keyword.Constant */
+.highlight .kd { font-weight: bold } /* Keyword.Declaration */
+.highlight .kn { font-weight: bold } /* Keyword.Namespace */
+.highlight .kp { font-weight: bold } /* Keyword.Pseudo */
+.highlight .kr { font-weight: bold } /* Keyword.Reserved */
+.highlight .kt { color: #445588; font-weight: bold } /* Keyword.Type */
+.highlight .m { color: #009999 } /* Literal.Number */
+.highlight .s { color: #d14 } /* Literal.String */
+.highlight .na { color: #008080 } /* Name.Attribute */
+.highlight .nb { color: #0086B3 } /* Name.Builtin */
+.highlight .nc { color: #445588; font-weight: bold } /* Name.Class */
+.highlight .no { color: #008080 } /* Name.Constant */
+.highlight .ni { color: #800080 } /* Name.Entity */
+.highlight .ne { color: #990000; font-weight: bold } /* Name.Exception */
+.highlight .nf { color: #990000; font-weight: bold } /* Name.Function */
+.highlight .nn { color: #555555 } /* Name.Namespace */
+.highlight .nt { color: #000080 } /* Name.Tag */
+.highlight .nv { color: #008080 } /* Name.Variable */
+.highlight .ow { font-weight: bold } /* Operator.Word */
+.highlight .w { color: #bbbbbb } /* Text.Whitespace */
+.highlight .mf { color: #009999 } /* Literal.Number.Float */
+.highlight .mh { color: #009999 } /* Literal.Number.Hex */
+.highlight .mi { color: #009999 } /* Literal.Number.Integer */
+.highlight .mo { color: #009999 } /* Literal.Number.Oct */
+.highlight .sb { color: #d14 } /* Literal.String.Backtick */
+.highlight .sc { color: #d14 } /* Literal.String.Char */
+.highlight .sd { color: #d14 } /* Literal.String.Doc */
+.highlight .s2 { color: #d14 } /* Literal.String.Double */
+.highlight .se { color: #d14 } /* Literal.String.Escape */
+.highlight .sh { color: #d14 } /* Literal.String.Heredoc */
+.highlight .si { color: #d14 } /* Literal.String.Interpol */
+.highlight .sx { color: #d14 } /* Literal.String.Other */
+.highlight .sr { color: #009926 } /* Literal.String.Regex */
+.highlight .s1 { color: #d14 } /* Literal.String.Single */
+.highlight .ss { color: #990073 } /* Literal.String.Symbol */
+.highlight .bp { color: #999999 } /* Name.Builtin.Pseudo */
+.highlight .vc { color: #008080 } /* Name.Variable.Class */
+.highlight .vg { color: #008080 } /* Name.Variable.Global */
+.highlight .vi { color: #008080 } /* Name.Variable.Instance */
+.highlight .il { color: #009999 } /* Literal.Number.Integer.Long */
+
+.type-csharp .highlight .k { color: #0000FF }
+.type-csharp .highlight .kt { color: #0000FF }
+.type-csharp .highlight .nf { color: #000000; font-weight: normal }
+.type-csharp .highlight .nc { color: #2B91AF }
+.type-csharp .highlight .nn { color: #000000 }
+.type-csharp .highlight .s { color: #A31515 }
+.type-csharp .highlight .sc { color: #A31515 }