stash_api 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ac36a7380c0a32c9849de48e57a8f1215b065742
-  data.tar.gz: a536d5ea4ae443344691f49736fccc7e3542bf24
+  metadata.gz: b3ec81f8d9a97960441b463f1e963cb0b69cc44b
+  data.tar.gz: 7134590611aaf4f9538f7b2d836a21802970529f
 SHA512:
-  metadata.gz: bc3589b49f7b3621219eaa38edfcd7dd3465a970bf2cab3306be9e27f07cfa75f6f749568d6127672da2b1119d22b626d93508b514fd203a137238d10038519e
-  data.tar.gz: f33106c04f3419d5777eec32f67f42288358af336dda3811c6e0503d945edb0c71b1529d0385bfb2a225fd894e1c1edec1ee220123cbb4fb4577138378a69200
+  metadata.gz: 2bf0c8080faf3c4383d825eab07cae2aff25610a0d1218ce6aee436a4d2cb6a9ae80879e87eda2615b614872910432e9c14fed1ae82656c0df00e1d96188cc39
+  data.tar.gz: 199c5afb721b5f012dbe25e65ce26c4c8103c40da0584542700ceaf0445e6030884f105e627d65c099335da62de1ac574e27981fe11ef265838502eda5e1ac01

data/README.md

@@ -1,8 +1,6 @@
 # StashAPI
 
-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/stash_api`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+A client for interacting with Atlassian Stash API
 
 ## Installation
 
@@ -22,18 +20,37 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+```ruby
+StashAPI::Base.domain("stash.mycompany.com") # address of your stash server
+StashAPI::Base.basic_auth("username", "password") # optional credentials
+```
+Now you can send requests to Stash
+```ruby
+# You can interact with the core rest API as follows
+StashAPI::Core.projects.fetch # to return projects
+StashAPI::Core.users.fetch # to return users
+
+# to supply query parameters pass them in as a hash
+StashAPI::Core.projects.fetch(name: "project_name")
+
+# or if you know the id/key of the resource
+StashAPI::Core.projects('ID').fetch
+```
+Users and projects are a top level resource, accessible directly from Core. To access something like pull requests you need to use resource chaining.
+```ruby
+# retrieves pull requests for the specified repo
+StashAPI::Core.projects('key').repos('slug').pull_requests.fetch
+```
 
 ## Development
 
-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. Run `bundle exec stash_api` to use the gem in this directory, ignoring other installed copies of this gem.
+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.
 
-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).
+To install this gem onto your local machine, run `bundle exec rake install`
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/stash_api. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
-
+Bug reports and pull requests are welcome on GitHub at https://github.com/zach-chai/stash_api. Please add tests to your pull requests so it isn't broken unintentionally.
 
 ## License
 

data/lib/stash_api/base.rb

@@ -4,6 +4,7 @@ module StashAPI
 
       def domain(value = nil)
         return Options.option(:domain) unless value
+        value.chomp! '/' if value[-1]
         Options.option :domain, value
       end
 

data/lib/stash_api/core.rb

@@ -1,11 +1,18 @@
 module StashAPI
   class Core < Resource
     class << self
+      @@position = 0
 
       def projects(id = nil)
-        add_resource_to_chain 0, 'projects', id
+        add_resource_to_chain @@position, 'projects', id
         Project
       end
+
+      def users(id = nil)
+        add_resource_to_chain @@position, 'users', id
+        User
+      end
+
     end
   end
 end

data/lib/stash_api/resource.rb

@@ -4,6 +4,8 @@ module StashAPI
     @@resource_ids = []
 
     def self.fetch(query = {})
+      raise "set a domain first 'StashAPI::Base.domain(<domain>)'" unless StashAPI::Options.option(:domain)
+
       options = {}
       options[:query] = query
 
@@ -18,8 +20,9 @@ module StashAPI
     end
 
     def self.fetch_all(query = {})
+      raise "set a domain first 'StashAPI::Base.domain(<domain>)'" unless StashAPI::Options.option(:domain)
+      
       options = {}
-
       query[:limit] = 1000
       query[:start] = 0
       options[:query] = query
@@ -41,6 +44,7 @@ module StashAPI
     end
 
     def self.create_resource(payload, options = {})
+      raise "set a domain first 'StashAPI::Base.domain(<domain>)'" unless StashAPI::Options.option(:domain)
 
       options[:body] = payload.to_json
       options[:headers] = {'Content-Type' => 'application/json'}

data/lib/stash_api/user.rb

@@ -0,0 +1,9 @@
+module StashAPI
+  class User < Resource
+    class << self
+      @@position = 1
+
+      #TODO add user operations
+    end
+  end
+end

data/lib/stash_api/version.rb

@@ -1,3 +1,3 @@
 module StashAPI
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/stash_api.rb

@@ -6,6 +6,7 @@ require 'stash_api/base'
 require 'stash_api/resource'
 require 'stash_api/core'
 require 'stash_api/project'
+require 'stash_api/user'
 require 'stash_api/repo'
 require 'stash_api/pull_request'
 require 'stash_api/comment'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stash_api
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Zachary Chai
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-12 00:00:00.000000000 Z
+date: 2015-07-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -91,6 +91,7 @@ files:
 - lib/stash_api/pull_request.rb
 - lib/stash_api/repo.rb
 - lib/stash_api/resource.rb
+- lib/stash_api/user.rb
 - lib/stash_api/version.rb
 - stash_api.gemspec
 homepage: