lightspeed_ruby 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 99c19349a0b1ae4455685c1725d8d8dffedc43a7
-  data.tar.gz: 33663fccc4c8bb1a93d1497d176764f29545cbbb
+  metadata.gz: 24292e2be0e108391527b5a082702ed2469972ca
+  data.tar.gz: 200dca39d1a5bddb8ab0062e196bcbd73993a508
 SHA512:
-  metadata.gz: 7480af20b6955a1d385b4559878602e063a0ffdbf76d021d93cc6663fcd157e32aab921118376a6d9c95fec0fda72c73de0a3f84c64e6098277e52a9d0e8b042
-  data.tar.gz: 69a5263c9fbb6a84e91a7c0a91eefd5b7e57d44cc69bd0a2375860a42d8867b049704bfba45cf0469211d0070971f17d51d083fc4824429801563877803c2abc
+  metadata.gz: ba1fb6f34da8fc8035f95e0acb4d7228d533a74ac7fee632783078eb93cd577b6e4b395fd034c9655c6af555b5e2eeca56d740e9c3c40fad20d8f09dc3144943
+  data.tar.gz: fec09d4ad79081243c3cf0e84632f5c0806ef50ec20a74a48068012ae4fa163b12a8b55c319f58ee44d0502c863b7a6597c32b38d9e9c48ae25a714f230db794

data/README.md

@@ -9,7 +9,7 @@ TODO: Delete this and the text above, and describe your gem
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'lightspeed'
+gem "lightspeed_ruby", require: "lightspeed"
 ```
 
 And then execute:
@@ -18,17 +18,35 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install lightspeed
+    $ gem install lightspeed_ruby
 
 ## Usage
 
-TODO: Write usage instructions here
+Lightspeed ruby follows a namespacing pattern, in which every layer of the
+Lightspeed's API creates a new namespace.
 
-## Development
+### Items
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+**Find an item**
 
-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).
+```ruby
+client.items.find("20")
+```
+
+**Create an item**
+
+```ruby
+client.items.create(description: "blah blah", itemType: "non_inventory")
+```
+
+### Relations
+
+Whenever the API allows it, you can ask for certain relations to be sideloaded.
+For example, you may wish to get the category of an item.
+
+```ruby
+client.items.find("20", with: [:category])
+```
 
 ## Contributing
 

data/lib/lightspeed/api/items.rb

@@ -13,6 +13,10 @@ module Lightspeed
         client.post("Account/#{client.account_id}/Item.json", body: attributes).body
       end
 
+      def archive(item_id)
+        client.delete("Account/#{client.account_id}/Item/#{item_id}.json").body
+      end
+
       private
 
       attr_reader :client

data/lib/lightspeed/api/sales.rb

@@ -9,6 +9,10 @@ module Lightspeed
 
       def sale_lines; API::Sales::SaleLines.new(client); end
 
+      def find(sale_id, with: [])
+        client.get("Account/#{client.account_id}/Sale/#{sale_id}.json", relations: with).body
+      end
+
       private
 
       attr_reader :client

data/lib/lightspeed/client.rb

@@ -28,6 +28,10 @@ module Lightspeed
       conn.post(url, body)
     end
 
+    def delete(url)
+      conn.delete(url)
+    end
+
     def accounts; API::Accounts.new(self); end
     def sales; API::Sales.new(self); end
     def customers; API::Customers.new(self); end

data/lib/lightspeed/version.rb

@@ -1,3 +1,3 @@
 module Lightspeed
-  VERSION = "0.1.4"
+  VERSION = "0.1.5"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lightspeed_ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Zamith
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-07-26 00:00:00.000000000 Z
+date: 2017-07-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler