Replaced token with a dummy string

.github/CODEOWNERS

@@ -0,0 +1,2 @@
+/lib/ @ignitionapp/back-end
+/spec/ @ignitionapp/back-end

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,7 @@
+**Intent (What)**
+
+**Motivation (Why)**
+
+**Implementation (How)**
+
+**Consequence**

.github/workflows/ruby.yml

@@ -0,0 +1,25 @@
+name: Ruby
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby 3.1
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 3.1.x
+    - name: Build and test with Rake
+      run: |
+        gem install bundler
+        bundle install --jobs 4 --retry 3
+        bundle exec rubocop
+        bundle exec rake

.rubocop.yml

@@ -3,7 +3,7 @@ require:
   - rubocop-rspec
 
 AllCops:
-  TargetRubyVersion: 2.6
+  TargetRubyVersion: 3.1
 
 Gemspec/OrderedDependencies:
   Enabled: false
@@ -47,6 +47,9 @@ Layout/HeredocIndentation:
 Layout/LeadingCommentSpace:
   Enabled: true
 
+Layout/LineLength:
+  Enabled: false
+
 Layout/MultilineArrayBraceLayout:
   Enabled: false
 
@@ -111,9 +114,6 @@ Metrics/PerceivedComplexity:
   Enabled: true
   Max: 10
 
-Metrics/LineLength:
-  Enabled: false
-
 Metrics/MethodLength:
   Enabled: true
   Max: 50
@@ -159,18 +159,6 @@ Naming/MethodParameterName:
 Naming/VariableNumber:
   Enabled: false
 
-Performance/Count:
-  Enabled: false
-
-Performance/Casecmp:
-  Enabled: false
-
-Performance/TimesMap:
-  Enabled: false
-
-Performance/RegexpMatch:
-  Enabled: false
-
 RSpec/AnyInstance:
   Enabled: false
 
@@ -354,6 +342,7 @@ Style/GuardClause:
 Style/HashSyntax:
   Enabled: true
   EnforcedStyle: ruby19_no_mixed_keys
+  EnforcedShorthandSyntax: never
 
 Style/IfUnlessModifier:
   Enabled: false
@@ -385,9 +374,6 @@ Style/MethodCallWithArgsParentheses:
     - to
     - not_to
 
-Style/MethodMissingSuper:
-  Enabled: false
-
 Style/MissingRespondToMissing:
   Enabled: false
 
@@ -464,3 +450,6 @@ Style/SymbolProc:
 
 Style/ZeroLengthPredicate:
   Enabled: false
+
+Style/MutableConstant:
+  Enabled: false

.travis.yml

@@ -2,5 +2,5 @@
 language: ruby
 cache: bundler
 rvm:
-  - 2.6.5
+  - 3.1.3
 before_install: gem install bundler -v 2.1.4

Gemfile.lock

@@ -1,57 +1,129 @@
 PATH
   remote: .
   specs:
-    xpm_ruby (0.1.0)
+    xpm_ruby (0.4.0)
+      activesupport
+      builder
+      dry-types
       faraday
+      faraday-encoding
+      ox (~> 2.13)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    ast (2.4.0)
-    diff-lcs (1.3)
-    faraday (1.0.1)
-      multipart-post (>= 1.2, < 3)
-    jaro_winkler (1.5.4)
-    multipart-post (2.1.1)
-    parallel (1.19.1)
-    parser (2.7.0.5)
-      ast (~> 2.4.0)
-    rainbow (3.0.0)
-    rake (13.0.1)
-    rspec (3.9.0)
-      rspec-core (~> 3.9.0)
-      rspec-expectations (~> 3.9.0)
-      rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.1)
-      rspec-support (~> 3.9.1)
-    rspec-expectations (3.9.1)
+    activesupport (7.1.1)
+      base64
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      connection_pool (>= 2.2.5)
+      drb
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      mutex_m
+      tzinfo (~> 2.0)
+    ast (2.4.2)
+    base64 (0.1.1)
+    bigdecimal (3.1.4)
+    builder (3.2.4)
+    byebug (11.1.3)
+    coderay (1.1.3)
+    concurrent-ruby (1.2.2)
+    connection_pool (2.4.1)
+    diff-lcs (1.5.0)
+    drb (2.1.1)
+      ruby2_keywords
+    dry-core (1.0.1)
+      concurrent-ruby (~> 1.0)
+      zeitwerk (~> 2.6)
+    dry-inflector (1.0.0)
+    dry-logic (1.5.0)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 1.0, < 2)
+      zeitwerk (~> 2.6)
+    dry-types (1.7.1)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 1.0)
+      dry-inflector (~> 1.0)
+      dry-logic (~> 1.4)
+      zeitwerk (~> 2.6)
+    faraday (2.7.11)
+      base64
+      faraday-net_http (>= 2.0, < 3.1)
+      ruby2_keywords (>= 0.0.4)
+    faraday-encoding (0.0.5)
+      faraday
+    faraday-net_http (3.0.2)
+    i18n (1.14.1)
+      concurrent-ruby (~> 1.0)
+    json (2.6.3)
+    method_source (1.0.0)
+    minitest (5.20.0)
+    mutex_m (0.1.2)
+    ox (2.14.17)
+    parallel (1.22.1)
+    parser (3.2.0.0)
+      ast (~> 2.4.1)
+    pry (0.14.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.10.1)
+      byebug (~> 11.0)
+      pry (>= 0.13, < 0.15)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.6.2)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.0)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.1)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.3)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.2)
-    rubocop (0.77.0)
-      jaro_winkler (~> 1.5.1)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.43.0)
+      json (~> 2.3)
       parallel (~> 1.10)
-      parser (>= 2.6)
+      parser (>= 3.2.0.0)
       rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.24.1, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 1.7)
-    rubocop-rspec (1.38.1)
-      rubocop (>= 0.68.1)
-    ruby-progressbar (1.10.1)
-    unicode-display_width (1.6.1)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.24.1)
+      parser (>= 3.1.1.0)
+    rubocop-capybara (2.17.0)
+      rubocop (~> 1.41)
+    rubocop-rspec (2.18.1)
+      rubocop (~> 1.33)
+      rubocop-capybara (~> 2.17)
+    ruby-progressbar (1.11.0)
+    ruby2_keywords (0.0.5)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.4.2)
+    vcr (6.1.0)
+    zeitwerk (2.6.12)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 2.0)
-  rake (>= 12.3.3)
-  rspec (~> 3.0)
-  rubocop (= 0.77.0)
+  bundler
+  byebug (~> 11)
+  pry-byebug (~> 3)
+  rake
+  rspec
+  rubocop
   rubocop-rspec
+  vcr
   xpm_ruby!
 
 BUNDLED WITH

README.md

@@ -1,38 +1,67 @@
 # XpmRuby
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/xpm_ruby`. To experiment with that code, run `bin/console` for an interactive prompt.
+This gem is used to access Xero's XPM api.
 
-TODO: Delete this and the text above, and describe your gem
+You will need to install and manage the access_tokens with Oauth 2.0 in your own app.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'xpm_ruby'
+gem "xpm_ruby", git: "https://github.com/ignitionapp/xpm_ruby"
 ```
 
 And then execute:
 
     $ bundle install
 
-Or install it yourself as:
+## Usage
 
-    $ gem install xpm_ruby
+Most of the API calls will require at least the two main following arguments
 
-## Usage
+1. `access_token` - the oauth2 access token (Oauth2 is not included here)
+1. `xero_tenant_id` - You get this by calling the xero api connection. See https://github.com/ignitionapp/xpm_ruby_demo/blob/master/subdomains/xpm_integration/access_token.rb for more details.
+
+Handling the refresh token and logging into Xero should all take place in the main app. The sample app is available at https://github.com/ignitionapp/xpm_ruby_demo
+
+Most of the time, you will be passing in a hash representation of the object you are working with (with one or two exceptions where it might be an ID or raw XML).
+
+The gem will convert the hash into the XML needed by the XPM api. The data that is returned will automatically be converted from XML to a Ruby Hash or Array.
+
+For example, a call to `XPMRuby::Staff.list(access_token: access_token, xero_tenant_id: xero_tenant_id)` will return an array of hashes representing the staff list.
+
+```ruby
+[
+    { "ID" => "859230", "Name" => "Dev Testing", "Email" => "dev@practiceignition.com", "Phone" => nil, "Mobile" => nil, "Address" => nil, "PayrollCode" => nil },
+    ...
+]
+```
 
-TODO: Write usage instructions here
+As much as possible, we have tried to keep to the same names as documented here: https://developer.xero.com/documentation/practice-manager/overview-practice-manager-api however we have not as yet added the full API (only the endpoints we are currently using in ignitionapp).
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+TODO set up this gem to release automatically when merged into master...
+
+Note: This gem is not released yet and is currently for internal use.
+
+Please refer to it via github for now
+e.g.
+`gem "xpm_ruby", git: "https://github.com/ignitionapp/xpm_ruby"`
+
+## Testing
+Rspec is used for testing
+
+`bundle exec rspec`
+
+In addition, rubocop is installed to check formatting and code quality
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+`bundle exec rubocop`
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/xpm_ruby.
+Bug reports and pull requests are welcome on GitHub at https://github.com/ignitionapp/xpm_ruby.
 
 
 ## License