インストール後に、node と npm の 2 つの新しいコマンドラインアプリケーションが利用可能になります。

npm install -g fh-fhc

sudo npm install -g fh-fhc

fhc -v

fhc completion >> ~/.bashrc

fhc target https://[your-studio-domain].feedhenry.com
fhc login [email address] [password]

fhc projects list

fhc help

SSH 公開キーが既に生成されているかどうかを確認するには、Linux や Mac では 端末 を、Windows では Git Bash を開きます。

ls -la ~/.ssh を実行します。

これで .ssh ディレクトリーのファイルが一覧表示されます。id_rsa.pub または id_dsa.pub のいずれかのファイルがある場合はキーが生成済みなので SSH 公開キーを FHC でプラットフォームに追加する に進みます。これらのファイルがない場合は SSH 公開キーを手動で生成する必要があるので、SSH 公開キーの生成 に進みます。

キーの生成には、ssh-keygen というツールを使用します。Linux や Mac では 端末 を、Windows では Git Bash を開きます。

以下を入力します。

ssh-keygen -t rsa -C "your_email_address@example.com"

このコマンドを入力すると、キーの保存場所を質問されます。リターンキーを押して、デフォルトの場所を使用します。

次に、秘密キーのパスワードの入力と確認を求められます。これが完了すると、公開キーと秘密キーがそれぞれ ~/.ssh/id_rsa.pub と ~/.ssh/id_rsa に書き込まれます。

FHC を使用してプラットフォームにログインします。公開キーを追加するには、名前とキーファイルの両方を指定する必要があります。以下のコマンドを入力してキーを追加します。

fhc keys ssh add <label> <key-file>

例を示します。

fhc keys ssh add myKey ~/.ssh/id_rsa.pub

以下のようにユーザーのすべての SSH キーを一覧表示すると、該当キーが正常に追加されたことを確認できます。

fhc keys ssh

これで追加されたキーが表示されます。

Studio を使用してプラットフォームに公開 SSH キーを追加するには、以下の手順に従います。

これで追加されたキーが一覧表示内に表示されます。

最初に fhc を使って RHMAP ドメインにターゲット設定 (接続) する必要があります。

コマンドラインアプリケーション (たとえば、Linux または MacOS の場合はターミナル、Windows の場合はコマンドプロンプト) を開きます。

<domain-url> をご使用のドメインの URL に置き換えてそのドメインをターゲットにします。

fhc target <domain-url>

次に RHMAP 認証情報を入力します。以下のコマンドで <email or alias> をユーザー名もしくはメールアドレスで置換して、実行します。

fhc login
Username : <email or alias>

パスワードを入力します。

Password : <enter password>

これでターゲットとする RHMAP ドメインにログインできました。

以下では、hello_world_project テンプレートをベースとした新しいプロジェクトを作成する方法について説明します。

利用可能なプロジェクトテンプレートを一覧表示するには、以下のコマンドを実行します。

fhc templates projects

project name を、選択したプロジェクト名に置き換えて、以下のコマンドを実行します。

fhc projects create <project name> hello_world_project

成功すると、以下のようにすべてのプロジェクト情報とともに JSON 応答が表示されます。

{
  "type": "PROJECT",
  "template": null,
  "sysCreated": 1397636395777,
  "guid": "jJHtgZXQPJxXDFJO2pQzMP-d",
  // ...
  "apps": [
    {
      "type": "client_hybrid",
      "description": "",
      "domain": "testing",
      "template": null,
      "email": "joebloggs@feedhenry.com",
      //...
    }
  ],
  "templateId": "default",
  "jsonTemplateId": "hello_world_project"
}

プロジェクト情報を見直す必要がある場合は、以下のコマンドを入力します。project guid を前のステップの guid で置き換えます。

fhc projects read <project guid>

このコマンドは、前のステップで示された JSON オブジェクトを返し、これにはプロジェクトの全情報が含まれます。

プロジェクトをローカルマシンにクローンします。project name を、選択したプロジェクト名に置き換え、project guid を JSON オブジェクトからの guid で置き換えます。

mkdir <project name> ; cd <project name> ; fhc projects clone <project guid>

MBaaS の例またはクラウドアプリを確認するために、project name をご使用のプロジェクト名に置き換えます。

cd <project name>-Hello-World-MBaaS-Instance ; ls -l

クラウドアプリの依存関係をインストールします。

npm install

-g フラグを使って grunt CLI をインストールし、grunt をグローバルでインストールします。

[sudo] npm install -g grunt-cli

これでクラウドアプリのインスタンスをローカルマシンにデプロイする準備ができました。

クラウドサーバーをローカルで起動するには、以下のコマンドを実行します。

grunt serve

コンソールに、クラウドアプリがローカルマシンの port 8001 で実行されていることを示す情報が表示されます。

ローカルマシンで以下の curl 要求を入力して、クラウドインスタンスが実行中であることを確認します。

curl http://localhost:8001/cloud/hello?hello=world

以下のような応答が表示されるはずです。

{
  "msg":"Hello world"
}

この curl で上記のような応答が返されると、クラウドアプリがローカルで実行されていることが確認できます。

以下のコマンドはチェーンコマンドであることに注意してください。最初の部分では、ディレクトリーツリーの 1 つ上のレベルに移動します。2 番目の部分では、1 つ下のレベルのクライアントディレクトリーに移動します。

project name をプロジェクト名で置き換え、以下のコマンドを実行します。

cd .. ;  cd <project name>-Hello-World-Client ; ls -l

クライアントアプリ用のすべての依存関係をインストールします。

npm install .

クライアントアプリをローカルで実行します。

grunt serve:local

成功すると、ウィンドウがデフォルトのブラウザーで開きます。

Platform ではすべての Git レポジトリーがホストされます。プロジェクト内の各アプリには独自の Git レポジトリーがあります。通常の Git 作業とプロセスは、クライアントアプリまたはクラウドアプリの例に移動することにより実行されます。

これで RHMAP プロジェクトをローカルで開発する設定が整いました。

端末に fhc targets を入力して利用可能なターゲットドメインを一覧表示します。

fhc targets list

fhc target コマンドを使用してターゲットドメインを選択します。

fhc target exampleDomain.redhatmobile.com

これでターゲットドメインが選択されました。ログインするには、fhc login の後にユーザー名とパスワードを続けます。

fhc login username@example.com password

既存のプロジェクトを一覧表示します。

fhc projects list

既存プロジェクトが最新更新日の順番で表示されます。例を示します。

--------------------------------------------------------------------------
| Id                       | Title            | No. Apps | Last Modified |
--------------------------------------------------------------------------
| 1234567890abcdefghijklmn | Hello World      | 3        | 3 hours ago   |
--------------------------------------------------------------------------
| 9876543210zyxwvutsrqpomn | Welcome to RHMAP | 2        | 3 hours ago   |
--------------------------------------------------------------------------

クライアントアプリやクラウドアプリを含まない新規プロジェクトを作成することは可能ですが、プロジェクトには名前を付けることが必要です。fhc projects create を使用してプロジェクトを作成します。

通常、新規プロジェクトは事前定義のテンプレートを使用して作成します。プロジェクトテンプレートを使用すると、普通は 1 つのクライアントアプリと 1 つのクラウドアプリを提供するプロジェクトテンプレートをクローンすることで開発をブーストラップすることができるようになります。

プロジェクトについての詳細は、プロジェクト を参照してください。

このチュートリアルでは、hello_world_project テンプレートを使用します。これは 1 つのクライアントアプリと 1 つのクラウドアプリを提供する基本的なプロジェクトで、標準の Hello World パラダイムを使用して基本的な機能が説明されます。

全プロジェクトテンプレートを一覧表示するには、以下を実行します。

fhc templates projects

hello_world_project テンプレートをベースにした新規プロジェクトを作成するには、以下を実行します。

fhc projects create helloWorld hello_world_project

以下を実行してプロジェクトが正常に作成されたことを確認します。

fhc projects list

別の方法では、以下のように fhc projects コマンドの出力を grep コマンドでパイプすることで、特定のプロジェクトを検索することもできます。

fhc projects list | grep 'helloWorld'

# Example:

XME5iUr2VoBV3DbXrVF7qApG ┃ helloWorld  ┃ 2  ┃ 3 minutes ago
# ProjectId | Title | Number of apps | Minutes since last update

コンソールの出力にクライアントアプリとクラウドアプリが含まれる、最近作成されたプロジェクトが表示されます。

プロジェクト内の全アプリを一覧表示するには、projectId ('guid' (Global Unique IDentifier) とも呼ぶ) を選択し、fhc apps と使用します。

fhc projects # lists all projects. Next, select a projectId

fhc apps <the_selected_project_guid>

これで指定された projectId のアプリすべてが表示されます。

プロジェクトには複数のアプリを含めることが可能ですが、相互に関係の内アプリは別個のプロジェクトに格納するようにします。アプリは通常、既存のアプリテンプレートを使ってプロジェクトに追加されます。クライアントおよびクラウドアプリの両方に多くのテンプレートが用意されています。

以下を実行して利用可能なアプリテンプレートを一覧表示します。

fhc templates apps

クライアントアプリをプロジェクトに追加するには、以下のコマンドを使用して、<projectId>、<appTitle> の名前、および <appTemplate> を指定します。

fhc app create --project=<projectId> --title=<appTitle> --type=<type> --template=<appTemplate>

 #The following example illustrates the creation of a new project

fhc app create --project=xe2cbz3cky6zfxq2ca66t55u --title='My Native iOS App' --type=client_native_ios --template=native_ios_swift_blank_app

プロジェクト内の全アプリを一覧表示して、アプリが正常に作成されたことを確認します。

fhc 、Node.js、および NPM 以外に、他の開発ツールが必要です。

sudo npm install -g grunt-cli

プロジェクト開発を含める新しいディレクトリーを作成します。

mkdir helloworld
cd helloworld

fhc projects clone <project-guid> を使用してプロジェクト内の全アプリのソースコードをクローンします。以下に例を示します。

fhc projects clone XME5iUr2VoBV3DbXrVF7qApG  # <== Replace this projectId with your projectId

以下のような出力メッセージが表示されます。

Cloning into 'helloWorld-Hello-World-Cloud-App'...

Cloning into 'helloWorld-Hello-World-Client'...

完了したら、作成された新しいディレクトリーを確認します。

ls

helloWorld-Hello-World-Client   helloWorld-Hello-World-Cloud-App

https://github.com/evanshortiss/rhmap-express-template などのリモートのリポジトリーからコードを使用するには、以下の手順を実行します。

これでアプリを開発してその結果を RHMAP にプッシュすることができます。

クラウドアプリにアクセスするには以下の 2 つの方法があります。

fhc app hosts --app=<app-guid> --env=<some-env>

{
  "url": "https://testing-3utxgzhawprfqot3tya04v5i-example.feedhenry.com"
}

cd <PROJECT-DIR>/helloWorld-Hello-World-Cloud-App

npm install

grunt serve

Running "env:local" (env) task

Running "concurrent:serve" (concurrent) task
Running "watch" task
Waiting...
Running "nodemon:dev" (nodemon) task
[nodemon] v1.0.20
[nodemon] to restart at any time, enter `rs`
[nodemon] watching: *.*
[nodemon] starting `node application.js`
App started at: Tue Sep 30 2014 15:39:07 GMT+0100 (IST) on port: 8001

curl -X POST http://localhost:8001/hello?hello=world

{"msg":"Hello world"}

grunt serve     #  'live reload' でサーバーをローカル実行
grunt test      # ローカルでテストを実行
grunt coverage  # コードカバレッジでテストを実行

クライアントアプリをローカルで実行します。

cd <PROJECT-DIR>/helloWorld-Hello-World-Client

クライアントアプリ向けのすべての依存関係 (主に grunt 関連) をインストールします。

npm install

Web ブラウザーセッションを開始します。

grunt serve:local

grunt serve:local により、デフォルトでポート 8001 でのローカル Node.js クラウドアプリへの接続が試行されます。以下のようなメッセージが表示されます。

Running "serve:local" (serve) task

Running "clean:server" (clean) task

Running "connect:livereload" (connect) task
Started connect web server on http://localhost:9002

Running "watch" task
Waiting...

詳細については、'Hello World Client' テンプレートアプリ向けの README.md を参照してください。

MBaaS サービスは Node.js アプリケーションです。MBaaS サービスは、Oracle 統合サービスのようなバックエンドシステムと統合するためにプロジェクトで使用できます。MBaaS サービスは 1 つ以上のプロジェクトと関連付けてアプリで利用できるようにする必要があります。そのようにしないと、プロジェクト内のアプリは MBaaS サービスにアクセスできません。MBaaS サービスの詳細については、relevant product documentation を参照してください。

サービスは、クラウドアプリから $fh.service クラウド API コールで呼び出されます。以下に例を示します。

$fh.service({
  guid: "PFi1ftKRBvlp-qSmgdcOeGe3",
  path: "/hello",
  method: "GET",
  params: {
    "hello": "world"
  }
}, function(err, data) {
  if (err) {
    return console.log(err);
  }
  return console.log(data);
});

ローカル開発環境から MBaaS サービスと対話するには、以下の間でマッピングが必要です。

Gruntfile.js での新しい環境変数の定義が必要です。

env : {
  options : {},
  // environment variables - see https://github.com/jsoverson/grunt-env for more information
  local: {
    FH_USE_LOCAL_DB: true,
    FH_SERVICE_MAP: function() {
      /*
       * ローカル開発用のサービスのマッピングをここで定義します。
       * アクセスしたい各サービスでマッピングを提供する必要があります。
       * これは、ローカルで実行中のサービスのインスタンスとする (ローカル開発用)
       * もしくはリモートインスタンスとすることができます。
       */
      var serviceMap = {
        'PFi1ftKRBvlp-qSmgdcOeGe3': 'http://127.0.0.1:8010'
      };
      return JSON.stringify(serviceMap);
    }
  }
},

上記の例では、FH_SERVICE_MAP がローカル環境変数の定義に追加されます。新しい変数は関数に対してマップされ、ポート 8010 でローカルで実行中のサービスを参照する GUID PFi1ftKRBvlp-qSmgdcOeGe3 を格納します。サービスのホスト済みインスタンスをターゲットにするには、Studio の Details ページにあるサービスの Current Host URL を使用してください。すべての追加サービスは serviceMap 変数に追加されます。

ユーザーは、文字列化された JSON オブジェクトではなく標準的な JSON オブジェクトとしてサービスマッピングを定義できます。以下の例では、FH_SERVICE_MAP 環境変数は標準的な JSON オブジェクトを使用して設定されます。

FH_SERVICE_MAP: '{"PFi1ftKRBvlp-qSmgdcOeGe3":"http://127.0.0.1:8010"}'

利用可能なサンプルは、ここで確認できます。

クラウドアプリのディレクトリーに移動し、./lib/hello.js を開きます。

応答で現在の時間を設定するパラメーターを追加するには、新しいパラメーターを GET と POST の両方の要求に入力します。

res.json({msg: 'Hello ' + world});

上記の内容を以下の内容に置き換えます。

res.json({msg: 'Hello ' + world, 'timestamp': new Date().getTime() });

これで応答にミリ秒単位の現在の時間がタイムスタンプに追加されます。これが 2 つあるのは、GET および POST リクエストの両方用にルートハンドラーがあるためです。

このファイルが保存されると、クラウドアプリは自動的に再起動します。ファイルの保存後に、以前実行した curl コマンドを再実行します。

curl -X POST http://localhost:8001/hello?hello=world

応答にタイムスタンプが含まれるようになります。

{"msg":"Hello World","timestamp":1412111429480}

クライアントアプリのディレクトリーに移動し、./www/index.html を開きます。これは、"name" 用の入力フィールドとクラウドを呼び出すボタンがある基本的な Web ページです。また、クラウドコールから応答に値を入力するために使用する cloudResponse div もあります。

コード "cloudResponse" の直下:

<div id="cloudResponse"></div>

timestamp div の追加:

<div id="timestamp"></div>

./www/hello.js で、クリックハンドラーは "Say Hello" ボタンに割り当てられます。トリガーされると、$fh.cloud API を使用してクラウドアプリの /hello エンドポイントが呼び出されます。

タイムスタンプを提供するには、./www/hello.js を開き、

document.getElementById('cloudResponse').innerHTML = "<p>" + res.msg + "</p>";

上記のコードの直下に以下のコードを追加します。

document.getElementById('timestamp').innerHTML = "<p>" + new Date(res.timestamp) + "</p>";

クライアントディレクトリーとクラウドディレクトリーで以下のコマンドを実行します。

git commit -am"Add timestamp parameter"
git push origin master

これで、ローカルで行われた変更が App Studio に表示されるようになります。

fh.db() や fh.cache() といった MBaaS API を使用した高度な開発には、別のソフトウェアが必要です。

特定のFHC コマンド実行時には、ユーザー ID を使用してプラットフォームと通信する必要があります。これには、ユーザーが fhc login コマンドを使用してプラットフォームにログインする必要があります。ユーザー API キーは FHC の使用で別の方法を提供します。ユーザー API キーを FHC で設定していれば、ログインコマンドを実行する必要がなくなります。プラットフォームとの通信時に、FHC は API キーを使用して認証することが可能になります。

fhc keys user target eb8d9b9ea050b9b23fea59e50ba281c67f3715e5

fhc keys user target

fhc keys user list

{
  "key": "eb8d9b9ea050b9b23fea59e50ba281c67f3715e5",
  "keyReference": "1j6qcwiziRkbYy6sUUHDooAY",
  "keyType": "user",
  "label": "test 1",
  "revoked": "2012-04-20T15:18:17.258Z",
  "revokedBy": "1j6qcwiziRkbYy6sUUHDooAY",
  "revokedEmail": "dev@example.com"
}

fhc keys user create test2

{
  "key": "22d0c0ac5990e8fd2c466c26db1a9eff8a171511",
  "keyReference": "1j6qcwiziRkbYy6sUUHDooAY",
  "keyType": "user",
  "label": "test2",
  "revoked": "",
  "revokedBy": "",
  "revokedEmail": ""
}

fhc keys user update 22d0c0ac5990e8fd2c466c26db1a9eff8a171511 test3

{
  "key": "22d0c0ac5990e8fd2c466c26db1a9eff8a171511",
  "keyReference": "1j6qcwiziRkbYy6sUUHDooAY",
  "keyType": "user",
  "label": "test3",
  "revoked": "",
  "revokedBy": "",
  "revokedEmail": ""
}

fhc keys user revoke 22d0c0ac5990e8fd2c466c26db1a9eff8a171511

{
  "key": "22d0c0ac5990e8fd2c466c26db1a9eff8a171511",
  "keyReference": "1j6qcwiziRkbYy6sUUHDooAY",
  "keyType": "user",
  "label": "test3",
  "revoked": "2012-04-20T16:14:11.702Z",
  "revokedBy": "1j6qcwiziRkbYy6sUUHDooAY",
  "revokedEmail": "dev@example.com"
}

パーミッションについての詳細は、「チームおよびコラボレーション」を参照してください。

fhc login myUsername myPassword

fhc projects create serviceProject

fhc projects | grep 'serviceProject'

fhc templates services

fhc services create paypalService paypal

FHC を使用すると、アプリの raw の JSON 統計情報データにアクセスできます。

特定アプリの統計情報 (タイマーおよびカウンター) にアクセスするには、以下のコマンドを使用します。

fhc stats <APP_ID> app <NUMBER_OF_RESULTS>

APP_ID は fhc apps コマンドで表示されるアプリの ID で、NUMBER_OF_RESULTS は表示する結果の最大数の数字で置き換えます。サンプルの統計情報は以下のようになります。

{
  interval: 10000,
  results: [
    {
      "ts": 1333107734000,
      "numStats": 6,
      "counters": [
        {
          "key": "DOMAIN_APPID_api_FUNCTIONNAME_active_requests",
          "value": {
            "value": 3,
            "valuePerSecond": 0.3
          }
        },
        {
          "key": "DOMAIN_APPID_api_FUNCTIONNAME2_active_requests",
          "value": {
            "value": 27,
            "valuePerSecond": 2.7
          }
        },
        {
          "key": "DOMAIN_APPID_api_FUNCTIONNAME3_active_requests",
          "value": {
            "value": 456,
            "valuePerSecond": 45.6
          }
        }
      ],
      "timers": [
        {
          "key": "DOMAIN_APPID_api_FUNCTIONNAME_request_times",
          "value": {
            "upper": 86,
            "lower": 63,
            "count": 17,
            "pcts": [
              {
                "pct": "90",
                "value": {
                  "mean": 76,
                  "upper": 86
                }
              }
            ]
          }
        },
        {
          "key": "DOMAIN_APPID_api_FUNCTIONNAME2_request_times",
          "value": {
            "upper": 99,
            "lower": 82,
            "count": 41,
            "pcts": [
              {
                "pct": "90",
                "value": {
                  "mean": 88.66666666666667,
                  "upper": 99
                }
              }
            ]
          }
        },
        {
          "key": "DOMAIN_APPID_api_FUNCTIONNAME3_request_times",
          "value": {
            "upper": 99,
            "lower": 75,
            "count": 2783,
            "pcts": [
              {
                "pct": "90",
                "value": {
                  "mean": 79.1254547827,
                  "upper": 99
                }
              }
            ]
          }
        }
      ]
    }
  ]
}

パーミッションについての詳細は、「チームおよびコラボレーション」を参照してください。

fhc projects create FormsProject forms_project

fhc forms create ~/Desktop/forms/smallForm.json

fhc forms apps update 534572a3fb19a3983fd92c15 5579624572fb19ajsfig398c

fhc themes create ~/Desktop/themes/CustomTheme.json

fhc themes app set HQgUjokQi7jizH8T-7TD4SQQ 534578160663a687117a4bd1

fhc apps create HQgUjokQi7jizH8T-7TD4SQQ Second_Form_App appforms_client

パーミッションについての詳細は、「チームおよびコラボレーション」を参照してください。

fhc target exampleDomain.feedhenry.com

fhc login testUser@example.com password

fhc forms

{
   "description":"This is a test form",
   "name":"Test Form",
   "updatedBy":"testing-admin@example.com",
   "pageRules":[

   ],
   "fieldRules":[

   ],
   "pages":[
      {
         "name":"Page 1",
         "fields":[
            {
               "fieldOptions":{
                  "definition":{
                     "defaultValue":""
                  }
               },
               "required":false,
               "type":"text",
               "name":"Text",
               "helpText":"Text",
               "repeating":false
            },
            {
               "required":false,
               "type":"file",
               "name":"File",
               "helpText":"File",
               "repeating":false
            }
         ]
      },
      {
         "name":"Page 2",
         "fields":[
            {
               "required":false,
               "type":"text",
               "name":"Page 2 Text",
               "helpText":"Page 2 Text",
               "repeating":false
            }
         ]
      }
   ],
   "lastUpdated":"2014-01-22T16:51:53.725Z",
   "dateCreated":"2014-01-22T14:43:21.806Z",
   "pageRef":{
      "52dfd909a926eb2e3f000001":0,
      "52dff729e02b762d3f000004":1
   },
   "fieldRef":{
      "52dfd93ee02b762d3f000001":{
         "page":0,
         "field":0
      },
      "52dfd93ee02b762d3f000002":{
         "page":0,
         "field":1
      },
      "52dff729e02b762d3f000003":{
         "page":1,
         "field":0
      }
   },
   "lastUpdatedTimestamp":1390409513725,
   "appsUsingForm":123,
   "submissionsToday":1234,
   "submissionsTotal":124125
}

fhc forms create ~/Desktop/forms/form.js

fhc forms get <app-id> > ~/Desktop/formFile.txt

fhc forms update ~/Desktop/formFiles/form

パーミッションについての詳細は、「チームおよびコラボレーション」を参照してください。

このチュートリアルを行うには、フォームが作成されている必要があります。新規フォームの作成については、フォームの作成 を参照してください。

fhc submissions list

fhc submissions get 534cf14de078a2c47291e5b3 savedSubmission.pdf

fhc submissions status 5335bc00d4598fdb5cae04f7

fhc submissions submitdata ~/Desktop/templateForSubmission.json

fhc complete submissions complete 5335bc00d4598fdb5cae04f7

fhc submissions export file=submissions.zip app=H_DNbFNJWS9uZIt7LJOkut20

パーミッションについての詳細は、「チームおよびコラボレーション」を参照してください。

fhc themes create ~/Desktop/themes/theme.json

fhc themes app set x5KmSy0gXPZOvpD_hHqCOwZe zRdUezAD3l11huedCk-WJswZ

fhc themes update ~/Desktop/themes/theme.json