prismic.io 1.0.0.rc3 → 1.0.0.rc4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 406a3849f94ecdfd3516db68fa2ee0d36ecf1c6a
-  data.tar.gz: f6988c94934d3a900af92cf6973dbb3c8d46d135
+  metadata.gz: 2e41d8f8a5ceae95d4e2c3ee77967e1357b2162f
+  data.tar.gz: 162469c32efb11a20f358f21baf3b2e5d8dc1fbd
 SHA512:
-  metadata.gz: 4f69e94c2b76f58b859ab8fac98c5a7a2ad09f2330fc05e1cf66daebf2d5913ac4d7f514d65f44833a4c10d8e98a3253bd0c6c7716e3bb9351a8218269dfc86b
-  data.tar.gz: 2f09cbb004acd083ffb16ab02dc19ab2e4862d019b105456d658de1f066528c1151a9c41695573dc6d98f7e147bf7eecb4bb9b68d4b55b6939bab041d781aa1e
+  metadata.gz: 491f3c1ef1646963a35e95e8a4a5f0aea0f5ec0ed78a92a0ecfc2e7666b40afbd39a459abf2701f61aed920d649704a3ecbde5415666a2534366aa313f53e5d0
+  data.tar.gz: a91edff448c3a0762e1cb4b76b5700ae4bde77a8f04902fa87eb39ab451e01a9a464bea8d09e84ce371b758c7aca3863264262c8d2128aa20cb5ecb331a4f01f

data/.travis.yml

@@ -1,5 +1,7 @@
 language: ruby
 rvm:
+  - 2.1.1
+  - 2.1.0
   - 2.0.0
   - 1.9.3
   - 1.9.2

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    prismic.io (1.0.0.rc3)
+    prismic.io (1.0.0.rc4)
 
 GEM
   remote: https://rubygems.org/

data/lib/prismic.rb

@@ -55,6 +55,18 @@ module Prismic
     API.start(url, opts)
   end
 
+  def self.oauth_initiate_url(url, oauth_opts, api_opts=nil)
+    api_opts ||= {}
+    api_opts = {access_token: opts} if api_opts.is_a?(String)
+    API.oauth_initiate_url(url, oauth_opts, api_opts)
+  end
+
+  def self.oauth_check_token(url, oauth_opts, api_opts=nil)
+    api_opts ||= {}
+    api_opts = {access_token: api_opts} if api_opts.is_a?(String)
+    API.oauth_check_token(url, oauth_opts, api_opts)
+  end
+
   class ApiData
     attr_accessor :refs, :bookmarks, :types, :tags, :forms
   end
@@ -366,12 +378,25 @@ module Prismic
       # - body: returns the response's body (as String)
       def get(uri, data={}, headers={})
         uri = URI(uri) if uri.is_a?(String)
-        uri.query = url_encode(data)
+        add_query(uri, data)
         http = Net::HTTP.new(uri.host, uri.port)
         http.use_ssl = uri.scheme =~ /https/i
         http.get(uri.request_uri, headers)
       end
 
+      # Performs a POST call and returns the result
+      #
+      # The result must respond to
+      # - code: returns the response's HTTP status code (as number or String)
+      # - body: returns the response's body (as String)
+      def post(uri, data={}, headers={})
+        uri = URI(uri) if uri.is_a?(String)
+        add_query(uri, data)
+        http = Net::HTTP.new(uri.host, uri.port)
+        http.use_ssl = uri.scheme =~ /https/i
+        http.post(uri.path, uri.query, headers)
+      end
+
       def url_encode(data)
         # Can't use URI.encode_www_form (doesn't support multi-values in 1.9.2)
         encode = ->(k, v){ "#{k}=#{CGI::escape(v)}" }
@@ -383,6 +408,14 @@ module Prismic
           end
         }.join("&")
       end
+
+      private
+
+      def add_query(uri, query)
+        query = url_encode(query)
+        query = "#{uri.query}&#{query}"if uri.query && !uri.query.empty?
+        uri.query = query
+      end
     end
   end
 

data/lib/prismic/api.rb

@@ -2,6 +2,8 @@
 module Prismic
   class API
     @@warned_create_search_form = false
+    @@warned_oauth_initiate_url = false
+    @@warned_oauth_check_token = false
     attr_reader :json, :access_token, :http_client
     attr_accessor :refs, :bookmarks, :forms, :tags, :types, :oauth
 
@@ -68,8 +70,24 @@ module Prismic
       data = {}
       data["access_token"] = access_token if access_token
       res = http_client.get(url, data, 'Accept' => 'application/json')
-      raise PrismicWSConnectionError, res unless res.code.to_s == '200'
-      res
+      case res.code
+      when '200'
+        res
+      when '401', '403'
+        begin
+          json = JSON.load(res.body)
+          raise PrismicWSAuthError.new(
+            json['error'],
+            json['oauth_initiate'],
+            json['oauth_token'],
+            http_client
+          )
+        rescue => e
+          raise PrismicWSConnectionError.new(res, e)
+        end
+      else
+        raise PrismicWSConnectionError, res
+      end
     end
 
     def self.start(url, opts={})
@@ -104,30 +122,48 @@ module Prismic
         }]
         api.tags = data['tags']
         api.types = data['types']
-        api.oauth = OAuth.new(data['oauth_initiate'], data['oauth_token'])
+        api.oauth = OAuth.new(data['oauth_initiate'], data['oauth_token'], http_client)
       }
     end
 
+    def self.oauth_initiate_url(url, oauth_opts, api_opts={})
+      oauth =
+        begin
+          api = self.start(url, api_opts)
+          api.oauth
+        rescue PrismicWSAuthError => e
+          e.oauth
+        end
+      oauth.initiate_url(oauth_opts)
+    end
+
     def oauth_initiate_url(opts)
-      oauth.initiate + "?" + {
-        "client_id" => opts.fetch(:client_id),
-        "redirect_uri" => opts.fetch(:redirect_uri),
-        "scope" => opts.fetch(:scope),
-      }.map{|kv| kv.map{|e| CGI.escape(e) }.join("=") }.join("&")
+      if !@@warned_oauth_initiate_url
+        warn "[DEPRECATION] Method `API#oauth_initiate_url` is deprecated.  " +
+          "Please use `Prismic::API.oauth_initiate_url` instead."
+        @@warned_oauth_initiate_url = true
+      end
+      oauth.initiate_url(opts)
     end
 
-    def oauth_check_token(params)
-      uri = URI(oauth.token)
-      res = Net::HTTP.post_form(uri, params)
-      if res.code == '200'
+    def self.oauth_check_token(url, oauth_params, api_opts={})
+      oauth =
         begin
-          JSON.parse(res.body)['access_token']
-        rescue Exception => e
-          raise PrismicWSConnectionError.new(res, e)
+          api = self.start(url, api_opts)
+          api.oauth
+        rescue PrismicWSAuthError => e
+          e.oauth
         end
-      else
-        raise PrismicWSConnectionError, res
+      oauth.check_token(oauth_params)
+    end
+
+    def oauth_check_token(params)
+      if !@@warned_oauth_check_token
+        warn "[DEPRECATION] Method `API#oauth_check_token` is deprecated.  " +
+          "Please use `Prismic::API.oauth_check_token` instead."
+        @@warned_oauth_check_token = true
       end
+      oauth.check_token(params)
     end
 
     private
@@ -140,12 +176,42 @@ module Prismic
       end
     end
 
+    class PrismicWSAuthError < Error
+      attr_reader :error, :oauth
+      def initialize(error, oauth_initialize, oauth_token, http_client)
+        super("Can't connect to Prismic's API: #{error}")
+        @error = error
+        @oauth = OAuth.new(oauth_initialize, oauth_token, http_client)
+      end
+    end
+
     class OAuth
-      attr_reader :initiate, :token
-      def initialize(initiate, token)
+      attr_reader :initiate, :token, :http_client
+      def initialize(initiate, token, http_client)
+        @http_client = http_client
         @initiate = initiate
         @token = token
       end
+      def initiate_url(opts)
+        initiate + "?" + {
+          "client_id" => opts.fetch(:client_id),
+          "redirect_uri" => opts.fetch(:redirect_uri),
+          "scope" => opts.fetch(:scope),
+        }.map{|kv| kv.map{|e| CGI.escape(e) }.join("=") }.join("&")
+      end
+      def check_token(params)
+        res = http_client.post(token, params)
+        if res.code == '200'
+          begin
+            JSON.parse(res.body)['access_token']
+          rescue Exception => e
+            raise PrismicWSConnectionError.new(res, e)
+          end
+        else
+          raise PrismicWSConnectionError, res
+        end
+      end
     end
+
   end
 end

data/lib/prismic/version.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 module Prismic
 
-  VERSION = "1.0.0.rc3"
+  VERSION = "1.0.0.rc4"
 
 end

data/spec/oauth_spec.rb

@@ -0,0 +1,121 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe 'OAuth' do
+
+  OAUTH_INITIATE_OPTS = {
+    client_id: "client_id",
+    redirect_uri: "http://myapp.com/callback",
+    scope: "master+releases",
+  }.freeze
+
+  OAUTH_CHECKTOKEN_OPTS = {
+    grant_type: "authorization_code",
+    code: "thecode",
+    redirect_uri: "http://myapp.com/callback",
+    client_id: "client_id",
+    client_secret: "client_secret",
+  }
+
+  describe "Public API" do
+
+    PUBLIC_URL = "https://lesbonneschoses.prismic.io/api"
+
+    it "should accept unauthenticated requests" do
+      expect {
+        Prismic.api(PUBLIC_URL, nil)
+      }.not_to raise_error()
+    end
+
+    describe "oauth_initiate_url" do
+
+      it "should returns the URL" do
+        url = Prismic::API.oauth_initiate_url(PUBLIC_URL, OAUTH_INITIATE_OPTS)
+        expected_url = [
+          "https://lesbonneschoses.prismic.io/auth?client_id=client_id",
+          "redirect_uri=http%3A%2F%2Fmyapp.com%2Fcallback",
+          "scope=master%2Breleases",
+        ].join("&")
+        url.should == expected_url
+      end
+
+    end
+
+    describe "oauth_check_token" do
+
+      it "should returns the URL" do
+        expect {
+          Prismic.oauth_check_token(PUBLIC_URL, OAUTH_CHECKTOKEN_OPTS)
+        }.to raise_error(
+          # we don't want to get a PrismicWSAuthError error here
+          Prismic::API::PrismicWSConnectionError,
+          "Can't connect to Prismic's API: 400 Bad Request"
+        )
+      end
+
+    end
+
+  end
+
+  describe "Private API" do
+
+    PRIVATE_URL = "https://privaterepository.prismic.io/api"
+
+    it "should deny unauthenticated requests" do
+      expect {
+        Prismic.api(PRIVATE_URL, nil)
+      }.to raise_error(Prismic::API::PrismicWSAuthError)
+    end
+
+    def catch_wserror(url)
+      Prismic.api(url, nil)
+    rescue Prismic::API::PrismicWSAuthError => e
+      e
+    end
+
+    it "should provide the error" do
+      error = catch_wserror(PRIVATE_URL)
+      error.error.should == "Invalid access token"
+    end
+
+    it "should provide oauth entry points" do
+      error = catch_wserror(PRIVATE_URL)
+      error.oauth.initiate.should == "https://privaterepository.prismic.io/auth"
+    end
+
+    it "should provide oauth token" do
+      error = catch_wserror(PRIVATE_URL)
+      error.oauth.token.should == "https://privaterepository.prismic.io/auth/token"
+    end
+
+    describe "oauth_initiate_url" do
+
+      it "should returns the URL" do
+        url = Prismic.oauth_initiate_url(PRIVATE_URL, OAUTH_INITIATE_OPTS)
+        expected_url = [
+          "https://privaterepository.prismic.io/auth?client_id=client_id",
+          "redirect_uri=http%3A%2F%2Fmyapp.com%2Fcallback",
+          "scope=master%2Breleases",
+        ].join("&")
+        url.should == expected_url
+      end
+
+    end
+
+    describe "oauth_check_token" do
+
+      it "should returns the URL" do
+        expect {
+          Prismic::API.oauth_check_token(PRIVATE_URL, OAUTH_CHECKTOKEN_OPTS)
+        }.to raise_error(
+          # we don't want to get a PrismicWSAuthError error here
+          Prismic::API::PrismicWSConnectionError,
+          "Can't connect to Prismic's API: 400 Bad Request"
+        )
+      end
+
+    end
+
+  end
+
+end

data/spec/prismic_spec.rb

@@ -24,7 +24,7 @@ describe 'Api' do
         'form3' => Prismic::Form.new(@api, 'form3', {}, nil, nil, nil, nil),
         'form4' => Prismic::Form.new(@api, 'form4', {}, nil, nil, nil, nil),
       }
-      api.oauth =  Prismic::API::OAuth.new(@oauth_initiate_url, "https://lesbonneschoses.prismic.io/auth/token")
+      api.oauth =  Prismic::API::OAuth.new(@oauth_initiate_url, "https://lesbonneschoses.prismic.io/auth/token", Prismic::DefaultHTTPClient)
     }
   end
 
@@ -234,7 +234,7 @@ describe 'Api' do
       @scope = "none"
     end
     def oauth_initiate_url
-      @api.oauth_initiate_url({
+      Prismic.oauth_initiate_url("https://lesbonneschoses.prismic.io/api", {
         client_id: @client_id,
         redirect_uri: @redirect_uri,
         scope: @scope,

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: prismic.io
 version: !ruby/object:Gem::Version
-  version: 1.0.0.rc3
+  version: 1.0.0.rc4
 platform: ruby
 authors:
 - Étienne Vallette d'Osia
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-20 00:00:00.000000000 Z
+date: 2014-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -102,6 +102,7 @@ files:
 - spec/fragments_spec.rb
 - spec/json_parsers_spec.rb
 - spec/lesbonneschoses_spec.rb
+- spec/oauth_spec.rb
 - spec/prismic_spec.rb
 - spec/responses_mocks/api.json
 - spec/responses_mocks/document.json
@@ -140,6 +141,7 @@ test_files:
 - spec/fragments_spec.rb
 - spec/json_parsers_spec.rb
 - spec/lesbonneschoses_spec.rb
+- spec/oauth_spec.rb
 - spec/prismic_spec.rb
 - spec/responses_mocks/api.json
 - spec/responses_mocks/document.json