proz 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c18e7d0bf3f798202808da666d007450ae88b40d
-  data.tar.gz: 80e8d2460a9511e094c99c65ecf4473fb4dbcfeb
+  metadata.gz: 40b3104e7d826fc8a20eae3297d5ccecb4893643
+  data.tar.gz: 3541b3ac232b3fac4a925bc11c65878b6aef6d5c
 SHA512:
-  metadata.gz: 16b1a0208aa205839f014dc171e4f7045202257308dd4fcb2abe1bf733cf1810f4decb6f6cd9471f658ca655253ba14929646ca14137c9569562f926f3b9f27e
-  data.tar.gz: 45a46efcf73c81692c259e83e528393447235ca83740a0aa97cdc352580f6c0a8b9f33190279bd39d69e9e6d45a45eb1584c93441a6106ab9703252326dbccd7
+  metadata.gz: ca80ec7a09ccc6b792489f3af34e69fbb2c73ae8d86b2af1ba3cd603fc1108b4c4ff1371e878bf29c35a74705bc613abc4671857fb3d9670e056f844dba01fcb
+  data.tar.gz: 67f51368ef8ae3966845bcab22969aa76f7b214d1bf7579fb5a3f90f9d3683620021e2e2eff68e654b5c5f00e39c0d9139728d7aa6676791b4a146610512fee0

data/README.md

@@ -20,9 +20,9 @@ gem 'proz'
 
 ## Usage
 
-#### Directory Service API
+### Directory Service API
 
-##### Freelancer
+#### Freelancer
 
 Get a representation of a single freelancer by providing that freelancer's [uuid](http://www.proz.com/api-docs/formats/uuid). The uuid is not provided publicly by ProZ so you have to obtain it either through the Freelancer Match API or the OAuth2 API.
 
@@ -41,7 +41,7 @@ freelancer.site_name
 
 Further details for each method can be found in the [ProZ API Specification](http://www.proz.com/api-docs/types/freelancer).
 
-##### Freelancer Matches
+#### Freelancer Matches
 
 Get freelancers that match a set of criteria. A [language pair](http://www.proz.com/api-docs/formats/language-pair) is required for this query. The language pair code should be in the form of a source language code, an underscore, and a target language code. The language codes are a variation of an earlier version of the ISO 639-2 standard, so please check the [ProZ language code](http://www.proz.com/api-docs/codes/language) list to make sure you have the correct language code.
 
@@ -57,7 +57,151 @@ fm.freelancer_matches[0]['freelancer']['uuid']
 # => 'b9eade6d-33ac-4c7d-b6f1-42905375fc0b'
 ```
 
-#### OAuth2
+#### WIWO (What I'm Working On)
+
+GET WIWO data
+
+Note that all referenced users are included in the response (using "side loading").
+
+```ruby
+wiwo = Proz::WiwoEntries.new(key: 'yourAPIkey')
+wiwo.entries
+
+# => {
+#     "_links": {
+#        "self": {
+#          "href": "https://api.proz.com/v2/wiwo"
+#        },
+#        "next": {
+#          "href": "https://api.proz.com/v2/wiwo?page=2"
+#        },
+#        "prev": {
+#          "href": null
+#        }
+#      },
+#      "wiwos": [
+#        {
+#          "id": 110,
+#          "self_link": "https://api.proz.com/v2/wiwo/110",
+#          "time": "2016-07-12T15:51:10+00:00",
+#          "user_eid": 1943273,
+#          "user_link": "https://api.proz.com/v2/users/fcfc20dc-bac6-41bd-8dbe-897e5aeefaac",
+#          "message": "Law-related articles from Arabic to Italian. About 30k words. Really demanding!",
+#          "message_language": null,
+#          "source_language": null,
+#          "target_language": null,
+#          "wordcount": null,
+#          "disc_gen_id": null,
+#          "disc_spec_id": null,
+#          "discipline": null,
+#          "cat_tool": null,
+#          "public": true,
+#          "num_replies": 3,
+#          "replies": [
+#            {
+#              "id": 1,
+#              "wiwo_id": 110,
+#              "wiwo_link": "https://api.proz.com/v2/wiwo/110",
+#              "time": "2016-07-11T19:02:54+00:00",
+#              "user_eid": 41429,
+#              "user_link": "https://api.proz.com/v2/users/32a9a4d0-cb6e-463f-a0ab-63d0a0418bc7",
+#              "message": "Test wiwo reply",
+#              "message_language": null
+#            },
+#            {
+#              "id": 2,
+#              "wiwo_id": 110,
+#              "wiwo_link": "https://api.proz.com/v2/wiwo/110",
+#              "time": "2016-07-11T19:03:38+00:00",
+#              "user_eid": 41429,
+#              "user_link": "https://api.proz.com/v2/users/32a9a4d0-cb6e-463f-a0ab-63d0a0418bc7",
+#              "message": "Test wiwo reply",
+#              "message_language": null
+#            },
+#            {
+#              "id": 3,
+#              "wiwo_id": 110,
+#              "wiwo_link": "https://api.proz.com/v2/wiwo/110",
+#              "time": "2016-07-11T19:04:48+00:00",
+#              "user_eid": 41429,
+#              "user_link": "https://api.proz.com/v2/users/32a9a4d0-cb6e-463f-a0ab-63d0a0418bc7",
+#              "message": "Test wiwo reply",
+#              "message_language": null
+#            }
+#          ]
+#        },
+#        { ... }
+#      ],
+#      "users": [
+#        {
+#          "self_link": "https://api.proz.com/v2/users/3f9f64e5-5ef7-4641-98aa-df01a228f44c",
+#          "uuid": "3f9f64e5-5ef7-4641-98aa-df01a228f44c",
+#          "site_name": "Alice Wolfe, DDS",
+#          "account_type": 2,
+#          "freelancer_profile_link": "https://api.proz.com/v2/freelancer/3f9f64e5-5ef7-4641-98aa-df01a228f44c",
+#          "profile_url": "http://www.proz.com/profile/610",
+#          "image_url": "https://static-ssl.proz.com/profile_resources/610_r4cd97b7149061.jpg",
+#          "is_proz_member": true,
+#          "proz_membership_type": "individual",
+#          "is_cpn": true,
+#          "cpn_language_pair": "eng_dan",
+#          "native_languages": [
+#            "dan"
+#          ],
+#          "timezone": "America/New_York",
+#          "country": "us",
+#          "skype": "awolfe"
+#        },
+#        { ... }
+#      ]
+#    }
+```
+
+POST WIWO
+
+Uses OAuth2 with the `wiwo.post` default scope. Use the [omniauth-proz](https://github.com/diasks2/omniauth-proz) gem to easily authenticate.
+
+Send a JSON object with the following fields. Only the "message" is required.
+* message (string) - a plain text message.
+* message_language (string) - a 3-character language code for the message.
+* source_language (string) - a 3-character language code for the source
+* target_language (string)
+* discipline (string) - a free-text discipline
+* wordcount (int) - the number of words completed
+* public (boolean) - whether or not the status update should be publicly visible.
+* cat_tool (string) - A free-text name of the CAT tool in use, if any.
+
+```
+Proz::WiwoEntry.new(
+  token: 'access_token',
+  message: "Hello World",
+  source_language: "eng",
+  target_language: "esp",
+  wordcount: 500,
+  discipline: "automotive",
+  message_language: "eng",
+  public: 1,
+  cat_tool: "Awesome CAT"
+).post
+```
+
+POST Reply
+
+Uses OAuth2 with the `wiwo.post` default scope. Use the [omniauth-proz](https://github.com/diasks2/omniauth-proz) gem to easily authenticate.
+
+Send a JSON object with the following fields. Only the "message" is required.
+* message (string) - a plain text message.
+* message_language (string) - a 3-character language code for the message.
+
+```
+Proz::WiwoReply.new(
+  token: 'access_token',
+  message: "Hello World",
+  message_language: "eng"
+).post
+```
+
+### OAuth2
 
 To Setup Your App with ProZ OAuth2:
 

data/lib/proz/version.rb

@@ -1,3 +1,3 @@
 module Proz
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/lib/proz/wiwo_entries.rb

@@ -4,9 +4,9 @@ module Proz
   class WiwoEntries
     include HTTParty
     base_uri "https://api.proz.com/v2"
-    attr_reader :api_key
-    def initialize(api_key:)
-      @api_key = api_key
+    attr_reader :key
+    def initialize(key:)
+      @key = key
     end
 
     def entries
@@ -22,13 +22,13 @@ module Proz
     end
 
     def user_entries(user_uuid)
-      self.class.get("/wiwo?user_uuid=" + user_uuid, headers: { 'X-Proz-API-Key' => api_key })
+      self.class.get("/wiwo?user_uuid=" + user_uuid, headers: { 'X-Proz-API-Key' => key })
     end
 
     private
 
     def all_wiwos
-      @wiwos ||= self.class.get("/wiwo", headers: { 'X-Proz-API-Key' => api_key })
+      @wiwos ||= self.class.get("/wiwo", headers: { 'X-Proz-API-Key' => key })
     end
   end
 end

data/lib/proz/wiwo_reply.rb

@@ -0,0 +1,22 @@
+require 'httparty'
+
+module Proz
+  class WiwoReply
+    include HTTParty
+    base_uri "https://api.proz.com/v2"
+    attr_reader :token, :id, :message, :options
+    def initialize(token:, id:, message:, **options)
+      @token = token
+      @id = id
+      @message = { message: message }
+      @options = options
+    end
+
+    def post
+      body = message.merge!(options)
+      self.class.post("/wiwo/#{id}/replies",
+        body: body,
+        headers: { 'Authorization' => "Bearer #{token}" } )
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: proz
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Kevin S. Dias
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-12 00:00:00.000000000 Z
+date: 2016-07-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -145,6 +145,7 @@ files:
 - lib/proz/version.rb
 - lib/proz/wiwo_entries.rb
 - lib/proz/wiwo_entry.rb
+- lib/proz/wiwo_reply.rb
 - proz.gemspec
 - spec/fixtures/vcr_cassettes/exchange_code_for_token.yml
 - spec/fixtures/vcr_cassettes/exchange_code_for_token_invalid_code.yml